aboutsummaryrefslogtreecommitdiff
path: root/readline/doc/readline.html
blob: d8a2edaf7d4ecd03ab6734492449761a346d6231 (plain) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327

<HTML>
<HEAD>
<!-- This HTML file has been created by texi2html 1.52
     from /usr/homes/chet/src/bash/readline-src/doc/rlman.texinfo on 1 March 2000 -->

<TITLE>GNU Readline Library</TITLE>
</HEAD>
<BODY>
<H1>GNU Readline Library</H1>
<H2>Edition 4.1, for <CODE>Readline Library</CODE> Version 4.1.</H2>
<H2>January 2000</H2>
<ADDRESS>Brian Fox, Free Software Foundation</ADDRESS>
<ADDRESS>Chet Ramey, Case Western Reserve University</ADDRESS>
<P>
<P><HR><P>
<H1>Table of Contents</H1>
<UL>
<LI><A NAME="TOC1" HREF="readline.html#SEC1">Command Line Editing</A>
<UL>
<LI><A NAME="TOC2" HREF="readline.html#SEC2">Introduction to Line Editing</A>
<LI><A NAME="TOC3" HREF="readline.html#SEC3">Readline Interaction</A>
<UL>
<LI><A NAME="TOC4" HREF="readline.html#SEC4">Readline Bare Essentials</A>
<LI><A NAME="TOC5" HREF="readline.html#SEC5">Readline Movement Commands</A>
<LI><A NAME="TOC6" HREF="readline.html#SEC6">Readline Killing Commands</A>
<LI><A NAME="TOC7" HREF="readline.html#SEC7">Readline Arguments</A>
<LI><A NAME="TOC8" HREF="readline.html#SEC8">Searching for Commands in the History</A>
</UL>
<LI><A NAME="TOC9" HREF="readline.html#SEC9">Readline Init File</A>
<UL>
<LI><A NAME="TOC10" HREF="readline.html#SEC10">Readline Init File Syntax</A>
<LI><A NAME="TOC11" HREF="readline.html#SEC11">Conditional Init Constructs</A>
<LI><A NAME="TOC12" HREF="readline.html#SEC12">Sample Init File</A>
</UL>
<LI><A NAME="TOC13" HREF="readline.html#SEC13">Bindable Readline Commands</A>
<UL>
<LI><A NAME="TOC14" HREF="readline.html#SEC14">Commands For Moving</A>
<LI><A NAME="TOC15" HREF="readline.html#SEC15">Commands For Manipulating The History</A>
<LI><A NAME="TOC16" HREF="readline.html#SEC16">Commands For Changing Text</A>
<LI><A NAME="TOC17" HREF="readline.html#SEC17">Killing And Yanking</A>
<LI><A NAME="TOC18" HREF="readline.html#SEC18">Specifying Numeric Arguments</A>
<LI><A NAME="TOC19" HREF="readline.html#SEC19">Letting Readline Type For You</A>
<LI><A NAME="TOC20" HREF="readline.html#SEC20">Keyboard Macros</A>
<LI><A NAME="TOC21" HREF="readline.html#SEC21">Some Miscellaneous Commands</A>
</UL>
<LI><A NAME="TOC22" HREF="readline.html#SEC22">Readline vi Mode</A>
</UL>
<LI><A NAME="TOC23" HREF="readline.html#SEC23">Programming with GNU Readline</A>
<UL>
<LI><A NAME="TOC24" HREF="readline.html#SEC24">Basic Behavior</A>
<LI><A NAME="TOC25" HREF="readline.html#SEC25">Custom Functions</A>
<UL>
<LI><A NAME="TOC26" HREF="readline.html#SEC26">The Function Type</A>
<LI><A NAME="TOC27" HREF="readline.html#SEC27">Writing a New Function</A>
</UL>
<LI><A NAME="TOC28" HREF="readline.html#SEC28">Readline Variables</A>
<LI><A NAME="TOC29" HREF="readline.html#SEC29">Readline Convenience Functions</A>
<UL>
<LI><A NAME="TOC30" HREF="readline.html#SEC30">Naming a Function</A>
<LI><A NAME="TOC31" HREF="readline.html#SEC31">Selecting a Keymap</A>
<LI><A NAME="TOC32" HREF="readline.html#SEC32">Binding Keys</A>
<LI><A NAME="TOC33" HREF="readline.html#SEC33">Associating Function Names and Bindings</A>
<LI><A NAME="TOC34" HREF="readline.html#SEC34">Allowing Undoing</A>
<LI><A NAME="TOC35" HREF="readline.html#SEC35">Redisplay</A>
<LI><A NAME="TOC36" HREF="readline.html#SEC36">Modifying Text</A>
<LI><A NAME="TOC37" HREF="readline.html#SEC37">Utility Functions</A>
<LI><A NAME="TOC38" HREF="readline.html#SEC38">Alternate Interface</A>
<LI><A NAME="TOC39" HREF="readline.html#SEC39">An Example</A>
</UL>
<LI><A NAME="TOC40" HREF="readline.html#SEC40">Readline Signal Handling</A>
<LI><A NAME="TOC41" HREF="readline.html#SEC41">Custom Completers</A>
<UL>
<LI><A NAME="TOC42" HREF="readline.html#SEC42">How Completing Works</A>
<LI><A NAME="TOC43" HREF="readline.html#SEC43">Completion Functions</A>
<LI><A NAME="TOC44" HREF="readline.html#SEC44">Completion Variables</A>
<LI><A NAME="TOC45" HREF="readline.html#SEC45">A Short Completion Example</A>
</UL>
</UL>
<LI><A NAME="TOC46" HREF="readline.html#SEC46">Concept Index</A>
<LI><A NAME="TOC47" HREF="readline.html#SEC47">Function and Variable Index</A>
</UL>
<P><HR><P>

<P>
This document describes the GNU Readline Library, a utility which aids
in the consistency of user interface across discrete programs that need
to provide a command line interface.

</P>
<P>
Published by the Free Software Foundation <BR>
59 Temple Place, Suite 330, <BR>
Boston, MA 02111 USA

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

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

</P>
<P>
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation approved
by the Free Software Foundation.

</P>
<P>
Copyright (C) 1988-1999 Free Software Foundation, Inc.

</P>



<H1><A NAME="SEC1" HREF="readline.html#TOC1">Command Line Editing</A></H1>

<P>
This chapter describes the basic features of the GNU
command line editing interface.

</P>

<UL>
<LI><A HREF="readline.html#SEC2">Introduction and Notation</A>: Notation used in this text.
<LI><A HREF="readline.html#SEC3">Readline Interaction</A>: The minimum set of commands for editing a line.
<LI><A HREF="readline.html#SEC9">Readline Init File</A>: Customizing Readline from a user's view.
<LI><A HREF="readline.html#SEC13">Bindable Readline Commands</A>: A description of most of the Readline commands
				available for binding
<LI><A HREF="readline.html#SEC22">Readline vi Mode</A>: A short description of how to make Readline
				behave like the vi editor.
</UL>



<H2><A NAME="SEC2" HREF="readline.html#TOC2">Introduction to Line Editing</A></H2>

<P>
The following paragraphs describe the notation used to represent
keystrokes.

</P>
<P>
The text <KBD>C-k</KBD> is read as `Control-K' and describes the character
produced when the <KBD>k</KBD> key is pressed while the Control key
is depressed.

</P>
<P>
The text <KBD>M-k</KBD> is read as `Meta-K' and describes the character
produced when the Meta key (if you have one) is depressed, and the <KBD>k</KBD>
key is pressed.
The Meta key is labeled <KBD>ALT</KBD> on many keyboards.
On keyboards with two keys labeled <KBD>ALT</KBD> (usually to either side of
the space bar), the <KBD>ALT</KBD> on the left side is generally set to
work as a Meta key.
The <KBD>ALT</KBD> key on the right may also be configured to work as a
Meta key or may be configured as some other modifier, such as a
Compose key for typing accented characters.

</P>
<P>
If you do not have a Meta or <KBD>ALT</KBD> key, or another key working as
a Meta key, the identical keystroke can be generated by typing <KBD>ESC</KBD>
<I>first</I>, and then typing <KBD>k</KBD>.
Either process is known as <EM>metafying</EM> the <KBD>k</KBD> key.

</P>
<P>
The text <KBD>M-C-k</KBD> is read as `Meta-Control-k' and describes the
character produced by <EM>metafying</EM> <KBD>C-k</KBD>.

</P>
<P>
In addition, several keys have their own names.  Specifically,
<KBD>DEL</KBD>, <KBD>ESC</KBD>, <KBD>LFD</KBD>, <KBD>SPC</KBD>, <KBD>RET</KBD>, and <KBD>TAB</KBD> all
stand for themselves when seen in this text, or in an init file
(see section <A HREF="readline.html#SEC9">Readline Init File</A>).
If your keyboard lacks a <KBD>LFD</KBD> key, typing <KBD>C-j</KBD> will
produce the desired character.
The <KBD>RET</KBD> key may be labeled <KBD>Return</KBD> or <KBD>Enter</KBD> on
some keyboards.

</P>


<H2><A NAME="SEC3" HREF="readline.html#TOC3">Readline Interaction</A></H2>
<P>
<A NAME="IDX1"></A>

</P>
<P>
Often during an interactive session you type in a long line of text,
only to notice that the first word on the line is misspelled.  The
Readline library gives you a set of commands for manipulating the text
as you type it in, allowing you to just fix your typo, and not forcing
you to retype the majority of the line.  Using these editing commands,
you move the cursor to the place that needs correction, and delete or
insert the text of the corrections.  Then, when you are satisfied with
the line, you simply press <KBD>RETURN</KBD>.  You do not have to be at the
end of the line to press <KBD>RETURN</KBD>; the entire line is accepted
regardless of the location of the cursor within the line.

</P>

<UL>
<LI><A HREF="readline.html#SEC4">Readline Bare Essentials</A>: The least you need to know about Readline.
<LI><A HREF="readline.html#SEC5">Readline Movement Commands</A>: Moving about the input line.
<LI><A HREF="readline.html#SEC6">Readline Killing Commands</A>: How to delete text, and how to get it back!
<LI><A HREF="readline.html#SEC7">Readline Arguments</A>: Giving numeric arguments to commands.
<LI><A HREF="readline.html#SEC8">Searching</A>: Searching through previous lines.
</UL>



<H3><A NAME="SEC4" HREF="readline.html#TOC4">Readline Bare Essentials</A></H3>
<P>
<A NAME="IDX2"></A>
<A NAME="IDX3"></A>
<A NAME="IDX4"></A>

</P>
<P>
In order to enter characters into the line, simply type them.  The typed
character appears where the cursor was, and then the cursor moves one
space to the right.  If you mistype a character, you can use your
erase character to back up and delete the mistyped character.

</P>
<P>
Sometimes you may mistype a character, and
not notice the error until you have typed several other characters.  In
that case, you can type <KBD>C-b</KBD> to move the cursor to the left, and then
correct your mistake.  Afterwards, you can move the cursor to the right
with <KBD>C-f</KBD>.

</P>
<P>
When you add text in the middle of a line, you will notice that characters
to the right of the cursor are `pushed over' to make room for the text
that you have inserted.  Likewise, when you delete text behind the cursor,
characters to the right of the cursor are `pulled back' to fill in the
blank space created by the removal of the text.  A list of the bare
essentials for editing the text of an input line follows.

</P>
<DL COMPACT>

<DT><KBD>C-b</KBD>
<DD>
Move back one character.
<DT><KBD>C-f</KBD>
<DD>
Move forward one character.
<DT><KBD>DEL</KBD> or <KBD>Backspace</KBD>
<DD>
Delete the character to the left of the cursor.
<DT><KBD>C-d</KBD>
<DD>
Delete the character underneath the cursor.
<DT>Printing characters
<DD>
Insert the character into the line at the cursor.
<DT><KBD>C-_</KBD> or <KBD>C-x C-u</KBD>
<DD>
Undo the last editing command.  You can undo all the way back to an
empty line.
</DL>

<P>
(Depending on your configuration, the <KBD>Backspace</KBD> key be set to
delete the character to the left of the cursor and the <KBD>DEL</KBD> key set
to delete the character underneath the cursor, like <KBD>C-d</KBD>, rather
than the character to the left of the cursor.)

</P>


<H3><A NAME="SEC5" HREF="readline.html#TOC5">Readline Movement Commands</A></H3>

<P>
The above table describes the most basic keystrokes that you need
in order to do editing of the input line.  For your convenience, many
other commands have been added in addition to <KBD>C-b</KBD>, <KBD>C-f</KBD>,
<KBD>C-d</KBD>, and <KBD>DEL</KBD>.  Here are some commands for moving more rapidly
about the line.

</P>
<DL COMPACT>

<DT><KBD>C-a</KBD>
<DD>
Move to the start of the line.
<DT><KBD>C-e</KBD>
<DD>
Move to the end of the line.
<DT><KBD>M-f</KBD>
<DD>
Move forward a word, where a word is composed of letters and digits.
<DT><KBD>M-b</KBD>
<DD>
Move backward a word.
<DT><KBD>C-l</KBD>
<DD>
Clear the screen, reprinting the current line at the top.
</DL>

<P>
Notice how <KBD>C-f</KBD> moves forward a character, while <KBD>M-f</KBD> moves
forward a word.  It is a loose convention that control keystrokes
operate on characters while meta keystrokes operate on words.

</P>


<H3><A NAME="SEC6" HREF="readline.html#TOC6">Readline Killing Commands</A></H3>

<P>
<A NAME="IDX5"></A>
<A NAME="IDX6"></A>

</P>
<P>
<EM>Killing</EM> text means to delete the text from the line, but to save
it away for later use, usually by <EM>yanking</EM> (re-inserting)
it back into the line.
(`Cut' and `paste' are more recent jargon for `kill' and `yank'.)

</P>
<P>
If the description for a command says that it `kills' text, then you can
be sure that you can get the text back in a different (or the same)
place later.

</P>
<P>
When you use a kill command, the text is saved in a <EM>kill-ring</EM>.
Any number of consecutive kills save all of the killed text together, so
that when you yank it back, you get it all.  The kill
ring is not line specific; the text that you killed on a previously
typed line is available to be yanked back later, when you are typing
another line.
<A NAME="IDX7"></A>

</P>
<P>
Here is the list of commands for killing text.

</P>
<DL COMPACT>

<DT><KBD>C-k</KBD>
<DD>
Kill the text from the current cursor position to the end of the line.

<DT><KBD>M-d</KBD>
<DD>
Kill from the cursor to the end of the current word, or, if between
words, to the end of the next word.
Word boundaries are the same as those used by <KBD>M-f</KBD>.

<DT><KBD>M-DEL</KBD>
<DD>
Kill from the cursor the start of the previous word, or, if between
words, to the start of the previous word.
Word boundaries are the same as those used by <KBD>M-b</KBD>.

<DT><KBD>C-w</KBD>
<DD>
Kill from the cursor to the previous whitespace.  This is different than
<KBD>M-DEL</KBD> because the word boundaries differ.

</DL>

<P>
Here is how to <EM>yank</EM> the text back into the line.  Yanking
means to copy the most-recently-killed text from the kill buffer.

</P>
<DL COMPACT>

<DT><KBD>C-y</KBD>
<DD>
Yank the most recently killed text back into the buffer at the cursor.

<DT><KBD>M-y</KBD>
<DD>
Rotate the kill-ring, and yank the new top.  You can only do this if
the prior command is <KBD>C-y</KBD> or <KBD>M-y</KBD>.
</DL>



<H3><A NAME="SEC7" HREF="readline.html#TOC7">Readline Arguments</A></H3>

<P>
You can pass numeric arguments to Readline commands.  Sometimes the
argument acts as a repeat count, other times it is the <I>sign</I> of the
argument that is significant.  If you pass a negative argument to a
command which normally acts in a forward direction, that command will
act in a backward direction.  For example, to kill text back to the
start of the line, you might type <SAMP>`M-- C-k'</SAMP>.

</P>
<P>
The general way to pass numeric arguments to a command is to type meta
digits before the command.  If the first `digit' typed is a minus
sign (<SAMP>`-'</SAMP>), then the sign of the argument will be negative.  Once
you have typed one meta digit to get the argument started, you can type
the remainder of the digits, and then the command.  For example, to give
the <KBD>C-d</KBD> command an argument of 10, you could type <SAMP>`M-1 0 C-d'</SAMP>.

</P>


<H3><A NAME="SEC8" HREF="readline.html#TOC8">Searching for Commands in the History</A></H3>

<P>
Readline provides commands for searching through the command history
for lines containing a specified string.
There are two search modes:  <VAR>incremental</VAR> and <VAR>non-incremental</VAR>.

</P>
<P>
Incremental searches begin before the user has finished typing the
search string.
As each character of the search string is typed, Readline displays
the next entry from the history matching the string typed so far.
An incremental search requires only as many characters as needed to
find the desired history entry.
To search backward in the history for a particular string, type
<KBD>C-r</KBD>.  Typing <KBD>C-s</KBD> searches forward through the history.
The characters present in the value of the <CODE>isearch-terminators</CODE> variable
are used to terminate an incremental search.
If that variable has not been assigned a value, the <KBD>ESC</KBD> and
<KBD>C-J</KBD> characters will terminate an incremental search.
<KBD>C-g</KBD> will abort an incremental search and restore the original line.
When the search is terminated, the history entry containing the
search string becomes the current line.

</P>
<P>
To find other matching entries in the history list, type <KBD>C-r</KBD> or
<KBD>C-s</KBD> as appropriate.
This will search backward or forward in the history for the next
entry matching the search string typed so far.
Any other key sequence bound to a Readline command will terminate
the search and execute that command.
For instance, a <KBD>RET</KBD> will terminate the search and accept
the line, thereby executing the command from the history list.

</P>
<P>
Non-incremental searches read the entire search string before starting
to search for matching history lines.  The search string may be
typed by the user or be part of the contents of the current line.

</P>


<H2><A NAME="SEC9" HREF="readline.html#TOC9">Readline Init File</A></H2>
<P>
<A NAME="IDX8"></A>

</P>
<P>
Although the Readline library comes with a set of Emacs-like
keybindings installed by default, it is possible to use a different set
of keybindings.
Any user can customize programs that use Readline by putting
commands in an <EM>inputrc</EM> file, conventionally in his home directory.
The name of this
file is taken from the value of the environment variable <CODE>INPUTRC</CODE>.  If
that variable is unset, the default is <TT>`~/.inputrc'</TT>.

</P>
<P>
When a program which uses the Readline library starts up, the
init file is read, and the key bindings are set.

</P>
<P>
In addition, the <CODE>C-x C-r</CODE> command re-reads this init file, thus
incorporating any changes that you might have made to it.

</P>

<UL>
<LI><A HREF="readline.html#SEC10">Readline Init File Syntax</A>: Syntax for the commands in the inputrc file.

<LI><A HREF="readline.html#SEC11">Conditional Init Constructs</A>: Conditional key bindings in the inputrc file.

<LI><A HREF="readline.html#SEC12">Sample Init File</A>: An example inputrc file.
</UL>



<H3><A NAME="SEC10" HREF="readline.html#TOC10">Readline Init File Syntax</A></H3>

<P>
There are only a few basic constructs allowed in the
Readline init file.  Blank lines are ignored.
Lines beginning with a <SAMP>`#'</SAMP> are comments.
Lines beginning with a <SAMP>`$'</SAMP> indicate conditional
constructs (see section <A HREF="readline.html#SEC11">Conditional Init Constructs</A>).  Other lines
denote variable settings and key bindings.

</P>
<DL COMPACT>

<DT>Variable Settings
<DD>
You can modify the run-time behavior of Readline by
altering the values of variables in Readline
using the <CODE>set</CODE> command within the init file.  Here is how to
change from the default Emacs-like key binding to use
<CODE>vi</CODE> line editing commands:


<PRE>
set editing-mode vi
</PRE>

A great deal of run-time behavior is changeable with the following
variables.

<DL COMPACT>

<DT><CODE>bell-style</CODE>
<DD>
<A NAME="IDX9"></A>
Controls what happens when Readline wants to ring the terminal bell.
If set to <SAMP>`none'</SAMP>, Readline never rings the bell.  If set to
<SAMP>`visible'</SAMP>, Readline uses a visible bell if one is available.
If set to <SAMP>`audible'</SAMP> (the default), Readline attempts to ring
the terminal's bell.

<DT><CODE>comment-begin</CODE>
<DD>
<A NAME="IDX10"></A>
The string to insert at the beginning of the line when the
<CODE>insert-comment</CODE> command is executed.  The default value
is <CODE>"#"</CODE>.

<DT><CODE>completion-ignore-case</CODE>
<DD>
If set to <SAMP>`on'</SAMP>, Readline performs filename matching and completion
in a case-insensitive fashion.
The default value is <SAMP>`off'</SAMP>.

<DT><CODE>completion-query-items</CODE>
<DD>
<A NAME="IDX11"></A>
The number of possible completions that determines when the user is
asked whether he wants to see the list of possibilities.  If the
number of possible completions is greater than this value,
Readline will ask the user whether or not he wishes to view
them; otherwise, they are simply listed.  The default limit is
<CODE>100</CODE>.

<DT><CODE>convert-meta</CODE>
<DD>
<A NAME="IDX12"></A>
If set to <SAMP>`on'</SAMP>, Readline will convert characters with the
eighth bit set to an ASCII key sequence by stripping the eighth
bit and prefixing an <KBD>ESC</KBD> character, converting them to a
meta-prefixed key sequence.  The default value is <SAMP>`on'</SAMP>.

<DT><CODE>disable-completion</CODE>
<DD>
<A NAME="IDX13"></A>
If set to <SAMP>`On'</SAMP>, Readline will inhibit word completion.
Completion  characters will be inserted into the line as if they had
been mapped to <CODE>self-insert</CODE>.  The default is <SAMP>`off'</SAMP>.

<DT><CODE>editing-mode</CODE>
<DD>
<A NAME="IDX14"></A>
The <CODE>editing-mode</CODE> variable controls which default set of
key bindings is used.  By default, Readline starts up in Emacs editing
mode, where the keystrokes are most similar to Emacs.  This variable can be
set to either <SAMP>`emacs'</SAMP> or <SAMP>`vi'</SAMP>.

<DT><CODE>enable-keypad</CODE>
<DD>
<A NAME="IDX15"></A>
When set to <SAMP>`on'</SAMP>, Readline will try to enable the application
keypad when it is called.  Some systems need this to enable the
arrow keys.  The default is <SAMP>`off'</SAMP>.

<DT><CODE>expand-tilde</CODE>
<DD>
<A NAME="IDX16"></A>
If set to <SAMP>`on'</SAMP>, tilde expansion is performed when Readline
attempts word completion.  The default is <SAMP>`off'</SAMP>.

<DT><CODE>horizontal-scroll-mode</CODE>
<DD>
<A NAME="IDX17"></A>
This variable can be set to either <SAMP>`on'</SAMP> or <SAMP>`off'</SAMP>.  Setting it
to <SAMP>`on'</SAMP> means that the text of the lines being edited will scroll
horizontally on a single screen line when they are longer than the width
of the screen, instead of wrapping onto a new screen line.  By default,
this variable is set to <SAMP>`off'</SAMP>.

<DT><CODE>input-meta</CODE>
<DD>
<A NAME="IDX18"></A>
<A NAME="IDX19"></A>
If set to <SAMP>`on'</SAMP>, Readline will enable eight-bit input (it
will not strip the eighth bit from the characters it reads),
regardless of what the terminal claims it can support.  The
default value is <SAMP>`off'</SAMP>.  The name <CODE>meta-flag</CODE> is a
synonym for this variable.

<DT><CODE>isearch-terminators</CODE>
<DD>
<A NAME="IDX20"></A>
The string of characters that should terminate an incremental search without
subsequently executing the character as a command (see section <A HREF="readline.html#SEC8">Searching for Commands in the History</A>).
If this variable has not been given a value, the characters <KBD>ESC</KBD> and
<KBD>C-J</KBD> will terminate an incremental search.

<DT><CODE>keymap</CODE>
<DD>
<A NAME="IDX21"></A>
Sets Readline's idea of the current keymap for key binding commands.
Acceptable <CODE>keymap</CODE> names are
<CODE>emacs</CODE>,
<CODE>emacs-standard</CODE>,
<CODE>emacs-meta</CODE>,
<CODE>emacs-ctlx</CODE>,
<CODE>vi</CODE>,
<CODE>vi-command</CODE>, and
<CODE>vi-insert</CODE>.
<CODE>vi</CODE> is equivalent to <CODE>vi-command</CODE>; <CODE>emacs</CODE> is
equivalent to <CODE>emacs-standard</CODE>.  The default value is <CODE>emacs</CODE>.
The value of the <CODE>editing-mode</CODE> variable also affects the
default keymap.

<DT><CODE>mark-directories</CODE>
<DD>
If set to <SAMP>`on'</SAMP>, completed directory names have a slash
appended.  The default is <SAMP>`on'</SAMP>.

<DT><CODE>mark-modified-lines</CODE>
<DD>
<A NAME="IDX22"></A>
This variable, when set to <SAMP>`on'</SAMP>, causes Readline to display an
asterisk (<SAMP>`*'</SAMP>) at the start of history lines which have been modified.
This variable is <SAMP>`off'</SAMP> by default.

<DT><CODE>output-meta</CODE>
<DD>
<A NAME="IDX23"></A>
If set to <SAMP>`on'</SAMP>, Readline will display characters with the
eighth bit set directly rather than as a meta-prefixed escape
sequence.  The default is <SAMP>`off'</SAMP>.

<DT><CODE>print-completions-horizontally</CODE>
<DD>
If set to <SAMP>`on'</SAMP>, Readline will display completions with matches
sorted horizontally in alphabetical order, rather than down the screen.
The default is <SAMP>`off'</SAMP>.

<DT><CODE>show-all-if-ambiguous</CODE>
<DD>
<A NAME="IDX24"></A>
This alters the default behavior of the completion functions.  If
set to <SAMP>`on'</SAMP>, 
words which have more than one possible completion cause the
matches to be listed immediately instead of ringing the bell.
The default value is <SAMP>`off'</SAMP>.

<DT><CODE>visible-stats</CODE>
<DD>
<A NAME="IDX25"></A>
If set to <SAMP>`on'</SAMP>, a character denoting a file's type
is appended to the filename when listing possible
completions.  The default is <SAMP>`off'</SAMP>.

</DL>

<DT>Key Bindings
<DD>
The syntax for controlling key bindings in the init file is
simple.  First you need to find the name of the command that you
want to change.  The following sections contain tables of the command
name, the default keybinding, if any, and a short description of what
the command does.

Once you know the name of the command, simply place the name of the key
you wish to bind the command to, a colon, and then the name of the
command on a line in the init file.  The name of the key
can be expressed in different ways, depending on which is most
comfortable for you.

<DL COMPACT>

<DT><VAR>keyname</VAR>: <VAR>function-name</VAR> or <VAR>macro</VAR>
<DD>
<VAR>keyname</VAR> is the name of a key spelled out in English.  For example:

<PRE>
Control-u: universal-argument
Meta-Rubout: backward-kill-word
Control-o: "&#62; output"
</PRE>

In the above example, <KBD>C-u</KBD> is bound to the function
<CODE>universal-argument</CODE>, and <KBD>C-o</KBD> is bound to run the macro
expressed on the right hand side (that is, to insert the text
<SAMP>`&#62; output'</SAMP> into the line).

<DT>"<VAR>keyseq</VAR>": <VAR>function-name</VAR> or <VAR>macro</VAR>
<DD>
<VAR>keyseq</VAR> differs from <VAR>keyname</VAR> above in that strings
denoting an entire key sequence can be specified, by placing
the key sequence in double quotes.  Some GNU Emacs style key
escapes can be used, as in the following example, but the
special character names are not recognized.


<PRE>
"\C-u": universal-argument
"\C-x\C-r": re-read-init-file
"\e[11~": "Function Key 1"
</PRE>

In the above example, <KBD>C-u</KBD> is bound to the function
<CODE>universal-argument</CODE> (just as it was in the first example),
<SAMP>`<KBD>C-x</KBD> <KBD>C-r</KBD>'</SAMP> is bound to the function <CODE>re-read-init-file</CODE>,
and <SAMP>`<KBD>ESC</KBD> <KBD>[</KBD> <KBD>1</KBD> <KBD>1</KBD> <KBD>~</KBD>'</SAMP> is bound to insert
the text <SAMP>`Function Key 1'</SAMP>.

</DL>

The following GNU Emacs style escape sequences are available when
specifying key sequences:

<DL COMPACT>

<DT><CODE><KBD>\C-</KBD></CODE>
<DD>
control prefix
<DT><CODE><KBD>\M-</KBD></CODE>
<DD>
meta prefix
<DT><CODE><KBD>\e</KBD></CODE>
<DD>
an escape character
<DT><CODE><KBD>\\</KBD></CODE>
<DD>
backslash
<DT><CODE><KBD>\"</KBD></CODE>
<DD>
<KBD>"</KBD>, a double quotation mark
<DT><CODE><KBD>\'</KBD></CODE>
<DD>
<KBD>'</KBD>, a single quote or apostrophe
</DL>

In addition to the GNU Emacs style escape sequences, a second
set of backslash escapes is available:

<DL COMPACT>

<DT><CODE>\a</CODE>
<DD>
alert (bell)
<DT><CODE>\b</CODE>
<DD>
backspace
<DT><CODE>\d</CODE>
<DD>
delete
<DT><CODE>\f</CODE>
<DD>
form feed
<DT><CODE>\n</CODE>
<DD>
newline
<DT><CODE>\r</CODE>
<DD>
carriage return
<DT><CODE>\t</CODE>
<DD>
horizontal tab
<DT><CODE>\v</CODE>
<DD>
vertical tab
<DT><CODE>\<VAR>nnn</VAR></CODE>
<DD>
the character whose <CODE>ASCII</CODE> code is the octal value <VAR>nnn</VAR>
(one to three digits)
<DT><CODE>\x<VAR>nnn</VAR></CODE>
<DD>
the character whose <CODE>ASCII</CODE> code is the hexadecimal value <VAR>nnn</VAR>
(one to three digits)
</DL>

When entering the text of a macro, single or double quotes must
be used to indicate a macro definition.
Unquoted text is assumed to be a function name.
In the macro body, the backslash escapes described above are expanded.
Backslash will quote any other character in the macro text,
including <SAMP>`"'</SAMP> and <SAMP>`''</SAMP>.
For example, the following binding will make <SAMP>`C-x \'</SAMP>
insert a single <SAMP>`\'</SAMP> into the line:

<PRE>
"\C-x\\": "\\"
</PRE>

</DL>



<H3><A NAME="SEC11" HREF="readline.html#TOC11">Conditional Init Constructs</A></H3>

<P>
Readline implements a facility similar in spirit to the conditional
compilation features of the C preprocessor which allows key
bindings and variable settings to be performed as the result
of tests.  There are four parser directives used.

</P>
<DL COMPACT>

<DT><CODE>$if</CODE>
<DD>
The <CODE>$if</CODE> construct allows bindings to be made based on the
editing mode, the terminal being used, or the application using
Readline.  The text of the test extends to the end of the line;
no characters are required to isolate it.

<DL COMPACT>

<DT><CODE>mode</CODE>
<DD>
The <CODE>mode=</CODE> form of the <CODE>$if</CODE> directive is used to test
whether Readline is in <CODE>emacs</CODE> or <CODE>vi</CODE> mode.
This may be used in conjunction
with the <SAMP>`set keymap'</SAMP> command, for instance, to set bindings in
the <CODE>emacs-standard</CODE> and <CODE>emacs-ctlx</CODE> keymaps only if
Readline is starting out in <CODE>emacs</CODE> mode.

<DT><CODE>term</CODE>
<DD>
The <CODE>term=</CODE> form may be used to include terminal-specific
key bindings, perhaps to bind the key sequences output by the
terminal's function keys.  The word on the right side of the
<SAMP>`='</SAMP> is tested against both the full name of the terminal and
the portion of the terminal name before the first <SAMP>`-'</SAMP>.  This
allows <CODE>sun</CODE> to match both <CODE>sun</CODE> and <CODE>sun-cmd</CODE>,
for instance.

<DT><CODE>application</CODE>
<DD>
The <VAR>application</VAR> construct is used to include
application-specific settings.  Each program using the Readline
library sets the <VAR>application name</VAR>, and you can test for it. 
This could be used to bind key sequences to functions useful for
a specific program.  For instance, the following command adds a
key sequence that quotes the current or previous word in Bash:

<PRE>
$if Bash
# Quote the current or previous word
"\C-xq": "\eb\"\ef\""
$endif
</PRE>

</DL>

<DT><CODE>$endif</CODE>
<DD>
This command, as seen in the previous example, terminates an
<CODE>$if</CODE> command.

<DT><CODE>$else</CODE>
<DD>
Commands in this branch of the <CODE>$if</CODE> directive are executed if
the test fails.

<DT><CODE>$include</CODE>
<DD>
This directive takes a single filename as an argument and reads commands
and bindings from that file.

<PRE>
$include /etc/inputrc
</PRE>

</DL>



<H3><A NAME="SEC12" HREF="readline.html#TOC12">Sample Init File</A></H3>

<P>
Here is an example of an inputrc file.  This illustrates key
binding, variable assignment, and conditional syntax.

</P>

<PRE>
# This file controls the behaviour of line input editing for
# programs that use the Gnu Readline library.  Existing programs
# include FTP, Bash, and Gdb.
#
# You can re-read the inputrc file with C-x C-r.
# Lines beginning with '#' are comments.
#
# First, include any systemwide bindings and variable assignments from
# /etc/Inputrc
$include /etc/Inputrc

#
# Set various bindings for emacs mode.

set editing-mode emacs 

$if mode=emacs

Meta-Control-h:	backward-kill-word	Text after the function name is ignored

#
# Arrow keys in keypad mode
#
#"\M-OD":        backward-char
#"\M-OC":        forward-char
#"\M-OA":        previous-history
#"\M-OB":        next-history
#
# Arrow keys in ANSI mode
#
"\M-[D":        backward-char
"\M-[C":        forward-char
"\M-[A":        previous-history
"\M-[B":        next-history
#
# Arrow keys in 8 bit keypad mode
#
#"\M-\C-OD":       backward-char
#"\M-\C-OC":       forward-char
#"\M-\C-OA":       previous-history
#"\M-\C-OB":       next-history
#
# Arrow keys in 8 bit ANSI mode
#
#"\M-\C-[D":       backward-char
#"\M-\C-[C":       forward-char
#"\M-\C-[A":       previous-history
#"\M-\C-[B":       next-history

C-q: quoted-insert

$endif

# An old-style binding.  This happens to be the default.
TAB: complete

# Macros that are convenient for shell interaction
$if Bash
# edit the path
"\C-xp": "PATH=${PATH}\e\C-e\C-a\ef\C-f"
# prepare to type a quoted word -- insert open and close double quotes
# and move to just after the open quote
"\C-x\"": "\"\"\C-b"
# insert a backslash (testing backslash escapes in sequences and macros)
"\C-x\\": "\\"
# Quote the current or previous word
"\C-xq": "\eb\"\ef\""
# Add a binding to refresh the line, which is unbound
"\C-xr": redraw-current-line
# Edit variable on current line.
"\M-\C-v": "\C-a\C-k$\C-y\M-\C-e\C-a\C-y="
$endif

# use a visible bell if one is available
set bell-style visible

# don't strip characters to 7 bits when reading
set input-meta on

# allow iso-latin1 characters to be inserted rather than converted to
# prefix-meta sequences
set convert-meta off

# display characters with the eighth bit set directly rather than
# as meta-prefixed characters
set output-meta on

# if there are more than 150 possible completions for a word, ask the
# user if he wants to see all of them
set completion-query-items 150

# For FTP
$if Ftp
"\C-xg": "get \M-?"
"\C-xt": "put \M-?"
"\M-.": yank-last-arg
$endif
</PRE>



<H2><A NAME="SEC13" HREF="readline.html#TOC13">Bindable Readline Commands</A></H2>


<UL>
<LI><A HREF="readline.html#SEC14">Commands For Moving</A>: Moving about the line.
<LI><A HREF="readline.html#SEC15">Commands For History</A>: Getting at previous lines.
<LI><A HREF="readline.html#SEC16">Commands For Text</A>: Commands for changing text.
<LI><A HREF="readline.html#SEC17">Commands For Killing</A>: Commands for killing and yanking.
<LI><A HREF="readline.html#SEC18">Numeric Arguments</A>: Specifying numeric arguments, repeat counts.
<LI><A HREF="readline.html#SEC19">Commands For Completion</A>: Getting Readline to do the typing for you.
<LI><A HREF="readline.html#SEC20">Keyboard Macros</A>: Saving and re-executing typed characters
<LI><A HREF="readline.html#SEC21">Miscellaneous Commands</A>: Other miscellaneous commands.
</UL>

<P>
This section describes Readline commands that may be bound to key
sequences.

</P>
<P>
Command names without an accompanying key sequence are unbound by default.
In the following descriptions, <VAR>point</VAR> refers to the current cursor
position, and <VAR>mark</VAR> refers to a cursor position saved by the
<CODE>set-mark</CODE> command.
The text between the point and mark is referred to as the <VAR>region</VAR>.

</P>


<H3><A NAME="SEC14" HREF="readline.html#TOC14">Commands For Moving</A></H3>
<DL COMPACT>

<DT><CODE>beginning-of-line (C-a)</CODE>
<DD>
<A NAME="IDX26"></A>
Move to the start of the current line.

<DT><CODE>end-of-line (C-e)</CODE>
<DD>
<A NAME="IDX27"></A>
Move to the end of the line.

<DT><CODE>forward-char (C-f)</CODE>
<DD>
<A NAME="IDX28"></A>
Move forward a character.

<DT><CODE>backward-char (C-b)</CODE>
<DD>
<A NAME="IDX29"></A>
Move back a character.

<DT><CODE>forward-word (M-f)</CODE>
<DD>
<A NAME="IDX30"></A>
Move forward to the end of the next word.  Words are composed of
letters and digits.

<DT><CODE>backward-word (M-b)</CODE>
<DD>
<A NAME="IDX31"></A>
Move back to the start of the current or previous word.  Words are
composed of letters and digits.

<DT><CODE>clear-screen (C-l)</CODE>
<DD>
<A NAME="IDX32"></A>
Clear the screen and redraw the current line,
leaving the current line at the top of the screen.

<DT><CODE>redraw-current-line ()</CODE>
<DD>
<A NAME="IDX33"></A>
Refresh the current line.  By default, this is unbound.

</DL>



<H3><A NAME="SEC15" HREF="readline.html#TOC15">Commands For Manipulating The History</A></H3>

<DL COMPACT>

<DT><CODE>accept-line (Newline, Return)</CODE>
<DD>
<A NAME="IDX34"></A>
Accept the line regardless of where the cursor is.  If this line is
non-empty, add it to the history list.  If this line was a history
line, then restore the history line to its original state.

<DT><CODE>previous-history (C-p)</CODE>
<DD>
<A NAME="IDX35"></A>
Move `up' through the history list.

<DT><CODE>next-history (C-n)</CODE>
<DD>
<A NAME="IDX36"></A>
Move `down' through the history list.

<DT><CODE>beginning-of-history (M-&#60;)</CODE>
<DD>
<A NAME="IDX37"></A>
Move to the first line in the history.

<DT><CODE>end-of-history (M-&#62;)</CODE>
<DD>
<A NAME="IDX38"></A>
Move to the end of the input history, i.e., the line currently
being entered.

<DT><CODE>reverse-search-history (C-r)</CODE>
<DD>
<A NAME="IDX39"></A>
Search backward starting at the current line and moving `up' through
the history as necessary.  This is an incremental search.

<DT><CODE>forward-search-history (C-s)</CODE>
<DD>
<A NAME="IDX40"></A>
Search forward starting at the current line and moving `down' through
the the history as necessary.  This is an incremental search.

<DT><CODE>non-incremental-reverse-search-history (M-p)</CODE>
<DD>
<A NAME="IDX41"></A>
Search backward starting at the current line and moving `up'
through the history as necessary using a non-incremental search
for a string supplied by the user.

<DT><CODE>non-incremental-forward-search-history (M-n)</CODE>
<DD>
<A NAME="IDX42"></A>
Search forward starting at the current line and moving `down'
through the the history as necessary using a non-incremental search
for a string supplied by the user.

<DT><CODE>history-search-forward ()</CODE>
<DD>
<A NAME="IDX43"></A>
Search forward through the history for the string of characters
between the start of the current line and the point.
This is a non-incremental search.
By default, this command is unbound.

<DT><CODE>history-search-backward ()</CODE>
<DD>
<A NAME="IDX44"></A>
Search backward through the history for the string of characters
between the start of the current line and the point.  This
is a non-incremental search.  By default, this command is unbound.

<DT><CODE>yank-nth-arg (M-C-y)</CODE>
<DD>
<A NAME="IDX45"></A>
Insert the first argument to the previous command (usually
the second word on the previous line).  With an argument <VAR>n</VAR>,
insert the <VAR>n</VAR>th word from the previous command (the words
in the previous command begin with word 0).  A negative argument
inserts the <VAR>n</VAR>th word from the end of the previous command.

<DT><CODE>yank-last-arg (M-., M-_)</CODE>
<DD>
<A NAME="IDX46"></A>
Insert last argument to the previous command (the last word of the
previous history entry).  With an
argument, behave exactly like <CODE>yank-nth-arg</CODE>.
Successive calls to <CODE>yank-last-arg</CODE> move back through the history
list, inserting the last argument of each line in turn.

</DL>



<H3><A NAME="SEC16" HREF="readline.html#TOC16">Commands For Changing Text</A></H3>

<DL COMPACT>

<DT><CODE>delete-char (C-d)</CODE>
<DD>
<A NAME="IDX47"></A>
Delete the character under the cursor.  If the cursor is at the
beginning of the line, there are no characters in the line, and
the last character typed was not bound to <CODE>delete-char</CODE>, then
return <CODE>EOF</CODE>.

<DT><CODE>backward-delete-char (Rubout)</CODE>
<DD>
<A NAME="IDX48"></A>
Delete the character behind the cursor.  A numeric argument means
to kill the characters instead of deleting them.

<DT><CODE>forward-backward-delete-char ()</CODE>
<DD>
<A NAME="IDX49"></A>
Delete the character under the cursor, unless the cursor is at the
end of the line, in which case the character behind the cursor is
deleted.  By default, this is not bound to a key.

<DT><CODE>quoted-insert (C-q, C-v)</CODE>
<DD>
<A NAME="IDX50"></A>
Add the next character typed to the line verbatim.  This is
how to insert key sequences like <KBD>C-q</KBD>, for example.

<DT><CODE>tab-insert (M-TAB)</CODE>
<DD>
<A NAME="IDX51"></A>
Insert a tab character.

<DT><CODE>self-insert (a, b, A, 1, !, ...)</CODE>
<DD>
<A NAME="IDX52"></A>
Insert yourself.

<DT><CODE>transpose-chars (C-t)</CODE>
<DD>
<A NAME="IDX53"></A>
Drag the character before the cursor forward over
the character at the cursor, moving the
cursor forward as well.  If the insertion point
is at the end of the line, then this
transposes the last two characters of the line.
Negative arguments have no effect.

<DT><CODE>transpose-words (M-t)</CODE>
<DD>
<A NAME="IDX54"></A>
Drag the word before point past the word after point,
moving point past that word as well.

<DT><CODE>upcase-word (M-u)</CODE>
<DD>
<A NAME="IDX55"></A>
Uppercase the current (or following) word.  With a negative argument,
uppercase the previous word, but do not move the cursor.

<DT><CODE>downcase-word (M-l)</CODE>
<DD>
<A NAME="IDX56"></A>
Lowercase the current (or following) word.  With a negative argument,
lowercase the previous word, but do not move the cursor.

<DT><CODE>capitalize-word (M-c)</CODE>
<DD>
<A NAME="IDX57"></A>
Capitalize the current (or following) word.  With a negative argument,
capitalize the previous word, but do not move the cursor.

</DL>



<H3><A NAME="SEC17" HREF="readline.html#TOC17">Killing And Yanking</A></H3>

<DL COMPACT>

<DT><CODE>kill-line (C-k)</CODE>
<DD>
<A NAME="IDX58"></A>
Kill the text from point to the end of the line.

<DT><CODE>backward-kill-line (C-x Rubout)</CODE>
<DD>
<A NAME="IDX59"></A>
Kill backward to the beginning of the line.

<DT><CODE>unix-line-discard (C-u)</CODE>
<DD>
<A NAME="IDX60"></A>
Kill backward from the cursor to the beginning of the current line.

<DT><CODE>kill-whole-line ()</CODE>
<DD>
<A NAME="IDX61"></A>
Kill all characters on the current line, no matter point is.
By default, this is unbound.

<DT><CODE>kill-word (M-d)</CODE>
<DD>
<A NAME="IDX62"></A>
Kill from point to the end of the current word, or if between
words, to the end of the next word.
Word boundaries are the same as <CODE>forward-word</CODE>.

<DT><CODE>backward-kill-word (M-DEL)</CODE>
<DD>
<A NAME="IDX63"></A>
Kill the word behind point.
Word boundaries are the same as <CODE>backward-word</CODE>.

<DT><CODE>unix-word-rubout (C-w)</CODE>
<DD>
<A NAME="IDX64"></A>
Kill the word behind point, using white space as a word boundary.
The killed text is saved on the kill-ring.

<DT><CODE>delete-horizontal-space ()</CODE>
<DD>
<A NAME="IDX65"></A>
Delete all spaces and tabs around point.  By default, this is unbound.

<DT><CODE>kill-region ()</CODE>
<DD>
<A NAME="IDX66"></A>
Kill the text in the current region.
By default, this command is unbound.

<DT><CODE>copy-region-as-kill ()</CODE>
<DD>
<A NAME="IDX67"></A>
Copy the text in the region to the kill buffer, so it can be yanked
right away.  By default, this command is unbound.

<DT><CODE>copy-backward-word ()</CODE>
<DD>
<A NAME="IDX68"></A>
Copy the word before point to the kill buffer.
The word boundaries are the same as <CODE>backward-word</CODE>.
By default, this command is unbound.

<DT><CODE>copy-forward-word ()</CODE>
<DD>
<A NAME="IDX69"></A>
Copy the word following point to the kill buffer.
The word boundaries are the same as <CODE>forward-word</CODE>.
By default, this command is unbound.

<DT><CODE>yank (C-y)</CODE>
<DD>
<A NAME="IDX70"></A>
Yank the top of the kill ring into the buffer at the current
cursor position.

<DT><CODE>yank-pop (M-y)</CODE>
<DD>
<A NAME="IDX71"></A>
Rotate the kill-ring, and yank the new top.  You can only do this if
the prior command is yank or yank-pop.
</DL>



<H3><A NAME="SEC18" HREF="readline.html#TOC18">Specifying Numeric Arguments</A></H3>
<DL COMPACT>

<DT><CODE>digit-argument (M-0, M-1, ... M--)</CODE>
<DD>
<A NAME="IDX72"></A>
Add this digit to the argument already accumulating, or start a new
argument.  <KBD>M--</KBD> starts a negative argument.

<DT><CODE>universal-argument ()</CODE>
<DD>
<A NAME="IDX73"></A>
This is another way to specify an argument.
If this command is followed by one or more digits, optionally with a
leading minus sign, those digits define the argument.
If the command is followed by digits, executing <CODE>universal-argument</CODE>
again ends the numeric argument, but is otherwise ignored.
As a special case, if this command is immediately followed by a
character that is neither a digit or minus sign, the argument count
for the next command is multiplied by four.
The argument count is initially one, so executing this function the
first time makes the argument count four, a second time makes the
argument count sixteen, and so on.
By default, this is not bound to a key.
</DL>



<H3><A NAME="SEC19" HREF="readline.html#TOC19">Letting Readline Type For You</A></H3>

<DL COMPACT>

<DT><CODE>complete (TAB)</CODE>
<DD>
<A NAME="IDX74"></A>
Attempt to do completion on the text before the cursor.  This is
application-specific.  Generally, if you are typing a filename
argument, you can do filename completion; if you are typing a command,
you can do command completion; if you are typing in a symbol to GDB, you
can do symbol name completion; if you are typing in a variable to Bash,
you can do variable name completion, and so on.

<DT><CODE>possible-completions (M-?)</CODE>
<DD>
<A NAME="IDX75"></A>
List the possible completions of the text before the cursor.

<DT><CODE>insert-completions (M-*)</CODE>
<DD>
<A NAME="IDX76"></A>
Insert all completions of the text before point that would have
been generated by <CODE>possible-completions</CODE>.

<DT><CODE>menu-complete ()</CODE>
<DD>
<A NAME="IDX77"></A>
Similar to <CODE>complete</CODE>, but replaces the word to be completed
with a single match from the list of possible completions.
Repeated execution of <CODE>menu-complete</CODE> steps through the list
of possible completions, inserting each match in turn.
At the end of the list of completions, the bell is rung and the
original text is restored.
An argument of <VAR>n</VAR> moves <VAR>n</VAR> positions forward in the list
of matches; a negative argument may be used to move backward
through the list.
This command is intended to be bound to <CODE>TAB</CODE>, but is unbound
by default.

<DT><CODE>delete-char-or-list ()</CODE>
<DD>
<A NAME="IDX78"></A>
Deletes the character under the cursor if not at the beginning or
end of the line (like <CODE>delete-char</CODE>).
If at the end of the line, behaves identically to
<CODE>possible-completions</CODE>.
This command is unbound by default.

</DL>



<H3><A NAME="SEC20" HREF="readline.html#TOC20">Keyboard Macros</A></H3>
<DL COMPACT>

<DT><CODE>start-kbd-macro (C-x ()</CODE>
<DD>
<A NAME="IDX79"></A>
Begin saving the characters typed into the current keyboard macro.

<DT><CODE>end-kbd-macro (C-x ))</CODE>
<DD>
<A NAME="IDX80"></A>
Stop saving the characters typed into the current keyboard macro
and save the definition.

<DT><CODE>call-last-kbd-macro (C-x e)</CODE>
<DD>
<A NAME="IDX81"></A>
Re-execute the last keyboard macro defined, by making the characters
in the macro appear as if typed at the keyboard.

</DL>



<H3><A NAME="SEC21" HREF="readline.html#TOC21">Some Miscellaneous Commands</A></H3>
<DL COMPACT>

<DT><CODE>re-read-init-file (C-x C-r)</CODE>
<DD>
<A NAME="IDX82"></A>
Read in the contents of the <VAR>inputrc</VAR> file, and incorporate
any bindings or variable assignments found there.

<DT><CODE>abort (C-g)</CODE>
<DD>
<A NAME="IDX83"></A>
Abort the current editing command and
ring the terminal's bell (subject to the setting of
<CODE>bell-style</CODE>).

<DT><CODE>do-uppercase-version (M-a, M-b, M-<VAR>x</VAR>, ...)</CODE>
<DD>
<A NAME="IDX84"></A>
If the metafied character <VAR>x</VAR> is lowercase, run the command
that is bound to the corresponding uppercase character.

<DT><CODE>prefix-meta (ESC)</CODE>
<DD>
<A NAME="IDX85"></A>
Make the next character typed be metafied.  This is for keyboards
without a meta key.  Typing <SAMP>`ESC f'</SAMP> is equivalent to typing
<SAMP>`M-f'</SAMP>.

<DT><CODE>undo (C-_, C-x C-u)</CODE>
<DD>
<A NAME="IDX86"></A>
Incremental undo, separately remembered for each line.

<DT><CODE>revert-line (M-r)</CODE>
<DD>
<A NAME="IDX87"></A>
Undo all changes made to this line.  This is like executing the <CODE>undo</CODE>
command enough times to get back to the beginning.

<DT><CODE>tilde-expand (M-~)</CODE>
<DD>
<A NAME="IDX88"></A>
Perform tilde expansion on the current word.

<DT><CODE>set-mark (C-@)</CODE>
<DD>
<A NAME="IDX89"></A>
Set the mark to the current point.  If a
numeric argument is supplied, the mark is set to that position.

<DT><CODE>exchange-point-and-mark (C-x C-x)</CODE>
<DD>
<A NAME="IDX90"></A>
Swap the point with the mark.  The current cursor position is set to
the saved position, and the old cursor position is saved as the mark.

<DT><CODE>character-search (C-])</CODE>
<DD>
<A NAME="IDX91"></A>
A character is read and point is moved to the next occurrence of that
character.  A negative count searches for previous occurrences.

<DT><CODE>character-search-backward (M-C-])</CODE>
<DD>
<A NAME="IDX92"></A>
A character is read and point is moved to the previous occurrence
of that character.  A negative count searches for subsequent
occurrences.

<DT><CODE>insert-comment (M-#)</CODE>
<DD>
<A NAME="IDX93"></A>
The value of the <CODE>comment-begin</CODE>
variable is inserted at the beginning of the current line,
and the line is accepted as if a newline had been typed.

<DT><CODE>dump-functions ()</CODE>
<DD>
<A NAME="IDX94"></A>
Print all of the functions and their key bindings to the
Readline output stream.  If a numeric argument is supplied,
the output is formatted in such a way that it can be made part
of an <VAR>inputrc</VAR> file.  This command is unbound by default.

<DT><CODE>dump-variables ()</CODE>
<DD>
<A NAME="IDX95"></A>
Print all of the settable variables and their values to the
Readline output stream.  If a numeric argument is supplied,
the output is formatted in such a way that it can be made part
of an <VAR>inputrc</VAR> file.  This command is unbound by default.

<DT><CODE>dump-macros ()</CODE>
<DD>
<A NAME="IDX96"></A>
Print all of the Readline key sequences bound to macros and the
strings they ouput.  If a numeric argument is supplied,
the output is formatted in such a way that it can be made part
of an <VAR>inputrc</VAR> file.  This command is unbound by default.

</DL>



<H2><A NAME="SEC22" HREF="readline.html#TOC22">Readline vi Mode</A></H2>

<P>
While the Readline library does not have a full set of <CODE>vi</CODE>
editing functions, it does contain enough to allow simple editing
of the line.  The Readline <CODE>vi</CODE> mode behaves as specified in
the POSIX 1003.2 standard.

</P>
<P>
In order to switch interactively between <CODE>emacs</CODE> and <CODE>vi</CODE>
editing modes, use the command M-C-j (toggle-editing-mode).
The Readline default is <CODE>emacs</CODE> mode.

</P>
<P>
When you enter a line in <CODE>vi</CODE> mode, you are already placed in
`insertion' mode, as if you had typed an <SAMP>`i'</SAMP>.  Pressing <KBD>ESC</KBD>
switches you into `command' mode, where you can edit the text of the
line with the standard <CODE>vi</CODE> movement keys, move to previous
history lines with <SAMP>`k'</SAMP> and subsequent lines with <SAMP>`j'</SAMP>, and
so forth.

</P>



<H1><A NAME="SEC23" HREF="readline.html#TOC23">Programming with GNU Readline</A></H1>

<P>
This chapter describes the interface between the GNU Readline Library and
other programs.  If you are a programmer, and you wish to include the
features found in GNU Readline
such as completion, line editing, and interactive history manipulation
in your own programs, this section is for you.

</P>

<UL>
<LI><A HREF="readline.html#SEC24">Basic Behavior</A>: Using the default behavior of Readline.
<LI><A HREF="readline.html#SEC25">Custom Functions</A>: Adding your own functions to Readline.
<LI><A HREF="readline.html#SEC28">Readline Variables</A>: Variables accessible to custom
					functions.
<LI><A HREF="readline.html#SEC29">Readline Convenience Functions</A>: Functions which Readline supplies to
					aid in writing your own custom
					functions.
<LI><A HREF="readline.html#SEC40">Readline Signal Handling</A>: How Readline behaves when it receives signals.
<LI><A HREF="readline.html#SEC41">Custom Completers</A>: Supplanting or supplementing Readline's
			completion functions.
</UL>



<H2><A NAME="SEC24" HREF="readline.html#TOC24">Basic Behavior</A></H2>

<P>
Many programs provide a command line interface, such as <CODE>mail</CODE>,
<CODE>ftp</CODE>, and <CODE>sh</CODE>.  For such programs, the default behaviour of
Readline is sufficient.  This section describes how to use Readline in
the simplest way possible, perhaps to replace calls in your code to
<CODE>gets()</CODE> or <CODE>fgets ()</CODE>.

</P>
<P>
<A NAME="IDX97"></A>
<A NAME="IDX98"></A>
The function <CODE>readline ()</CODE> prints a prompt and then reads and returns
a single line of text from the user.  The line <CODE>readline</CODE>
returns is allocated with <CODE>malloc ()</CODE>; you should <CODE>free ()</CODE>
the line when you are done with it.  The declaration for <CODE>readline</CODE>
in ANSI C is

</P>

<PRE>
<CODE>char *readline (char *<VAR>prompt</VAR>);</CODE>
</PRE>

<P>
So, one might say

<PRE>
<CODE>char *line = readline ("Enter a line: ");</CODE>
</PRE>

<P>
in order to read a line of text from the user.
The line returned has the final newline removed, so only the
text remains.

</P>
<P>
If <CODE>readline</CODE> encounters an <CODE>EOF</CODE> while reading the line, and the
line is empty at that point, then <CODE>(char *)NULL</CODE> is returned.
Otherwise, the line is ended just as if a newline had been typed.

</P>
<P>
If you want the user to be able to get at the line later, (with
<KBD>C-p</KBD> for example), you must call <CODE>add_history ()</CODE> to save the
line away in a <EM>history</EM> list of such lines.

</P>

<PRE>
<CODE>add_history (line)</CODE>;
</PRE>

<P>
For full details on the GNU History Library, see the associated manual.

</P>
<P>
It is preferable to avoid saving empty lines on the history list, since
users rarely have a burning need to reuse a blank line.  Here is
a function which usefully replaces the standard <CODE>gets ()</CODE> library
function, and has the advantage of no static buffer to overflow:

</P>

<PRE>
/* A static variable for holding the line. */
static char *line_read = (char *)NULL;

/* Read a string, and return a pointer to it.  Returns NULL on EOF. */
char *
rl_gets ()
{
  /* If the buffer has already been allocated, return the memory
     to the free pool. */
  if (line_read)
    {
      free (line_read);
      line_read = (char *)NULL;
    }

  /* Get a line from the user. */
  line_read = readline ("");

  /* If the line has any text in it, save it on the history. */
  if (line_read &#38;&#38; *line_read)
    add_history (line_read);

  return (line_read);
}
</PRE>

<P>
This function gives the user the default behaviour of <KBD>TAB</KBD>
completion: completion on file names.  If you do not want Readline to
complete on filenames, you can change the binding of the <KBD>TAB</KBD> key
with <CODE>rl_bind_key ()</CODE>.

</P>

<PRE>
<CODE>int rl_bind_key (int <VAR>key</VAR>, int (*<VAR>function</VAR>)());</CODE>
</PRE>

<P>
<CODE>rl_bind_key ()</CODE> takes two arguments: <VAR>key</VAR> is the character that
you want to bind, and <VAR>function</VAR> is the address of the function to
call when <VAR>key</VAR> is pressed.  Binding <KBD>TAB</KBD> to <CODE>rl_insert ()</CODE>
makes <KBD>TAB</KBD> insert itself.
<CODE>rl_bind_key ()</CODE> returns non-zero if <VAR>key</VAR> is not a valid
ASCII character code (between 0 and 255).

</P>
<P>
Thus, to disable the default <KBD>TAB</KBD> behavior, the following suffices:

<PRE>
<CODE>rl_bind_key ('\t', rl_insert);</CODE>
</PRE>

<P>
This code should be executed once at the start of your program; you
might write a function called <CODE>initialize_readline ()</CODE> which
performs this and other desired initializations, such as installing
custom completers (see section <A HREF="readline.html#SEC41">Custom Completers</A>).

</P>


<H2><A NAME="SEC25" HREF="readline.html#TOC25">Custom Functions</A></H2>

<P>
Readline provides many functions for manipulating the text of
the line, but it isn't possible to anticipate the needs of all
programs.  This section describes the various functions and variables
defined within the Readline library which allow a user program to add
customized functionality to Readline.

</P>
<P>
Before declaring any functions that customize Readline's behavior, or
using any functionality Readline provides in other code, an
application writer should include the file <CODE>&#60;readline/readline.h&#62;</CODE>
in any file that uses Readline's features.  Since some of the definitions
in <CODE>readline.h</CODE> use the <CODE>stdio</CODE> library, the file
<CODE>&#60;stdio.h&#62;</CODE> should be included before <CODE>readline.h</CODE>.

</P>

<UL>
<LI><A HREF="readline.html#SEC26">The Function Type</A>: C declarations to make code readable.
<LI><A HREF="readline.html#SEC27">Function Writing</A>: Variables and calling conventions.
</UL>



<H3><A NAME="SEC26" HREF="readline.html#TOC26">The Function Type</A></H3>

<P>
For readabilty, we declare a new type of object, called
<EM>Function</EM>.  A <CODE>Function</CODE> is a C function which
returns an <CODE>int</CODE>.  The type declaration for <CODE>Function</CODE> is:

</P>
<P>
<CODE>typedef int Function ();</CODE>

</P>
<P>
The reason for declaring this new type is to make it easier to write
code describing pointers to C functions.  Let us say we had a variable
called <VAR>func</VAR> which was a pointer to a function.  Instead of the
classic C declaration

</P>
<P>
<CODE>int (*)()func;</CODE>

</P>
<P>
we may write

</P>
<P>
<CODE>Function *func;</CODE>

</P>
<P>
Similarly, there are

</P>

<PRE>
typedef void VFunction ();
typedef char *CPFunction (); and
typedef char **CPPFunction ();
</PRE>

<P>
for functions returning no value, <CODE>pointer to char</CODE>, and
<CODE>pointer to pointer to char</CODE>, respectively.

</P>


<H3><A NAME="SEC27" HREF="readline.html#TOC27">Writing a New Function</A></H3>

<P>
In order to write new functions for Readline, you need to know the
calling conventions for keyboard-invoked functions, and the names of the
variables that describe the current state of the line read so far.

</P>
<P>
The calling sequence for a command <CODE>foo</CODE> looks like

</P>

<PRE>
<CODE>foo (int count, int key)</CODE>
</PRE>

<P>
where <VAR>count</VAR> is the numeric argument (or 1 if defaulted) and
<VAR>key</VAR> is the key that invoked this function.

</P>
<P>
It is completely up to the function as to what should be done with the
numeric argument.  Some functions use it as a repeat count, some
as a flag, and others to choose alternate behavior (refreshing the current
line as opposed to refreshing the screen, for example).  Some choose to
ignore it.  In general, if a
function uses the numeric argument as a repeat count, it should be able
to do something useful with both negative and positive arguments.
At the very least, it should be aware that it can be passed a
negative argument.

</P>


<H2><A NAME="SEC28" HREF="readline.html#TOC28">Readline Variables</A></H2>

<P>
These variables are available to function writers.

</P>
<P>
<DL>
<DT><U>Variable:</U> char * <B>rl_line_buffer</B>
<DD><A NAME="IDX99"></A>
This is the line gathered so far.  You are welcome to modify the
contents of the line, but see section <A HREF="readline.html#SEC34">Allowing Undoing</A>.  The
function <CODE>rl_extend_line_buffer</CODE> is available to increase
the memory allocated to <CODE>rl_line_buffer</CODE>.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> int <B>rl_point</B>
<DD><A NAME="IDX100"></A>
The offset of the current cursor position in <CODE>rl_line_buffer</CODE>
(the <EM>point</EM>).
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> int <B>rl_end</B>
<DD><A NAME="IDX101"></A>
The number of characters present in <CODE>rl_line_buffer</CODE>.  When
<CODE>rl_point</CODE> is at the end of the line, <CODE>rl_point</CODE> and
<CODE>rl_end</CODE> are equal.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> int <B>rl_mark</B>
<DD><A NAME="IDX102"></A>
The mark (saved position) in the current line.  If set, the mark
and point define a <EM>region</EM>.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> int <B>rl_done</B>
<DD><A NAME="IDX103"></A>
Setting this to a non-zero value causes Readline to return the current
line immediately.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> int <B>rl_pending_input</B>
<DD><A NAME="IDX104"></A>
Setting this to a value makes it the next keystroke read.  This is a
way to stuff a single character into the input stream.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> int <B>rl_erase_empty_line</B>
<DD><A NAME="IDX105"></A>
Setting this to a non-zero value causes Readline to completely erase
the current line, including any prompt, any time a newline is typed as
the only character on an otherwise-empty line.  The cursor is moved to
the beginning of the newly-blank line.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> char * <B>rl_prompt</B>
<DD><A NAME="IDX106"></A>
The prompt Readline uses.  This is set from the argument to
<CODE>readline ()</CODE>, and should not be assigned to directly.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> int <B>rl_already_prompted</B>
<DD><A NAME="IDX107"></A>
If an application wishes to display the prompt itself, rather than have
Readline do it the first time <CODE>readline()</CODE> is called, it should set
this variable to a non-zero value after displaying the prompt.
The prompt must also be passed as the argument to <CODE>readline()</CODE> so
the redisplay functions can update the display properly.
The calling application is responsible for managing the value; Readline
never sets it.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> char * <B>rl_library_version</B>
<DD><A NAME="IDX108"></A>
The version number of this revision of the library.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> char * <B>rl_terminal_name</B>
<DD><A NAME="IDX109"></A>
The terminal type, used for initialization.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> char * <B>rl_readline_name</B>
<DD><A NAME="IDX110"></A>
This variable is set to a unique name by each application using Readline.
The value allows conditional parsing of the inputrc file
(see section <A HREF="readline.html#SEC11">Conditional Init Constructs</A>).
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> FILE * <B>rl_instream</B>
<DD><A NAME="IDX111"></A>
The stdio stream from which Readline reads input.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> FILE * <B>rl_outstream</B>
<DD><A NAME="IDX112"></A>
The stdio stream to which Readline performs output.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> Function * <B>rl_startup_hook</B>
<DD><A NAME="IDX113"></A>
If non-zero, this is the address of a function to call just
before <CODE>readline</CODE> prints the first prompt.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> Function * <B>rl_pre_input_hook</B>
<DD><A NAME="IDX114"></A>
If non-zero, this is the address of a function to call after
the first prompt has been printed and just before <CODE>readline</CODE>
starts reading input characters.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> Function * <B>rl_event_hook</B>
<DD><A NAME="IDX115"></A>
If non-zero, this is the address of a function to call periodically
when readline is waiting for terminal input.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> Function * <B>rl_getc_function</B>
<DD><A NAME="IDX116"></A>
If non-zero, <CODE>readline</CODE> will call indirectly through this pointer
to get a character from the input stream.  By default, it is set to
<CODE>rl_getc</CODE>, the default <CODE>readline</CODE> character input function
(see section <A HREF="readline.html#SEC37">Utility Functions</A>).
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> VFunction * <B>rl_redisplay_function</B>
<DD><A NAME="IDX117"></A>
If non-zero, <CODE>readline</CODE> will call indirectly through this pointer
to update the display with the current contents of the editing buffer.
By default, it is set to <CODE>rl_redisplay</CODE>, the default <CODE>readline</CODE>
redisplay function (see section <A HREF="readline.html#SEC35">Redisplay</A>).
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> Keymap <B>rl_executing_keymap</B>
<DD><A NAME="IDX118"></A>
This variable is set to the keymap (see section <A HREF="readline.html#SEC31">Selecting a Keymap</A>) in which the
currently executing readline function was found.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> Keymap <B>rl_binding_keymap</B>
<DD><A NAME="IDX119"></A>
This variable is set to the keymap (see section <A HREF="readline.html#SEC31">Selecting a Keymap</A>) in which the
last key binding occurred.
</DL>

</P>


<H2><A NAME="SEC29" HREF="readline.html#TOC29">Readline Convenience Functions</A></H2>


<UL>
<LI><A HREF="readline.html#SEC30">Function Naming</A>: How to give a function you write a name.
<LI><A HREF="readline.html#SEC31">Keymaps</A>: Making keymaps.
<LI><A HREF="readline.html#SEC32">Binding Keys</A>: Changing Keymaps.
<LI><A HREF="readline.html#SEC33">Associating Function Names and Bindings</A>: Translate function names to
						key sequences.
<LI><A HREF="readline.html#SEC34">Allowing Undoing</A>: How to make your functions undoable.
<LI><A HREF="readline.html#SEC35">Redisplay</A>: Functions to control line display.
<LI><A HREF="readline.html#SEC36">Modifying Text</A>: Functions to modify <CODE>rl_line_buffer</CODE>.
<LI><A HREF="readline.html#SEC37">Utility Functions</A>: Generally useful functions and hooks.
<LI><A HREF="readline.html#SEC38">Alternate Interface</A>: Using Readline in a `callback' fashion.
</UL>



<H3><A NAME="SEC30" HREF="readline.html#TOC30">Naming a Function</A></H3>

<P>
The user can dynamically change the bindings of keys while using
Readline.  This is done by representing the function with a descriptive
name.  The user is able to type the descriptive name when referring to
the function.  Thus, in an init file, one might find

</P>

<PRE>
Meta-Rubout:	backward-kill-word
</PRE>

<P>
This binds the keystroke <KBD>Meta-Rubout</KBD> to the function
<EM>descriptively</EM> named <CODE>backward-kill-word</CODE>.  You, as the
programmer, should bind the functions you write to descriptive names as
well.  Readline provides a function for doing that:

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_add_defun</B> <I>(char *name, Function *function, int key)</I>
<DD><A NAME="IDX120"></A>
Add <VAR>name</VAR> to the list of named functions.  Make <VAR>function</VAR> be
the function that gets called.  If <VAR>key</VAR> is not -1, then bind it to
<VAR>function</VAR> using <CODE>rl_bind_key ()</CODE>.
</DL>

</P>
<P>
Using this function alone is sufficient for most applications.  It is
the recommended way to add a few functions to the default functions that
Readline has built in.  If you need to do something other
than adding a function to Readline, you may need to use the
underlying functions described below.

</P>


<H3><A NAME="SEC31" HREF="readline.html#TOC31">Selecting a Keymap</A></H3>

<P>
Key bindings take place on a <EM>keymap</EM>.  The keymap is the
association between the keys that the user types and the functions that
get run.  You can make your own keymaps, copy existing keymaps, and tell
Readline which keymap to use.

</P>
<P>
<DL>
<DT><U>Function:</U> Keymap <B>rl_make_bare_keymap</B> <I>()</I>
<DD><A NAME="IDX121"></A>
Returns a new, empty keymap.  The space for the keymap is allocated with
<CODE>malloc ()</CODE>; you should <CODE>free ()</CODE> it when you are done.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> Keymap <B>rl_copy_keymap</B> <I>(Keymap map)</I>
<DD><A NAME="IDX122"></A>
Return a new keymap which is a copy of <VAR>map</VAR>.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> Keymap <B>rl_make_keymap</B> <I>()</I>
<DD><A NAME="IDX123"></A>
Return a new keymap with the printing characters bound to rl_insert,
the lowercase Meta characters bound to run their equivalents, and
the Meta digits bound to produce numeric arguments.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> void <B>rl_discard_keymap</B> <I>(Keymap keymap)</I>
<DD><A NAME="IDX124"></A>
Free the storage associated with <VAR>keymap</VAR>.
</DL>

</P>
<P>
Readline has several internal keymaps.  These functions allow you to
change which keymap is active.

</P>
<P>
<DL>
<DT><U>Function:</U> Keymap <B>rl_get_keymap</B> <I>()</I>
<DD><A NAME="IDX125"></A>
Returns the currently active keymap.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> void <B>rl_set_keymap</B> <I>(Keymap keymap)</I>
<DD><A NAME="IDX126"></A>
Makes <VAR>keymap</VAR> the currently active keymap.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> Keymap <B>rl_get_keymap_by_name</B> <I>(char *name)</I>
<DD><A NAME="IDX127"></A>
Return the keymap matching <VAR>name</VAR>.  <VAR>name</VAR> is one which would
be supplied in a <CODE>set keymap</CODE> inputrc line (see section <A HREF="readline.html#SEC9">Readline Init File</A>).
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> char * <B>rl_get_keymap_name</B> <I>(Keymap keymap)</I>
<DD><A NAME="IDX128"></A>
Return the name matching <VAR>keymap</VAR>.  <VAR>name</VAR> is one which would
be supplied in a <CODE>set keymap</CODE> inputrc line (see section <A HREF="readline.html#SEC9">Readline Init File</A>).
</DL>

</P>


<H3><A NAME="SEC32" HREF="readline.html#TOC32">Binding Keys</A></H3>

<P>
You associate keys with functions through the keymap.  Readline has
several internal keymaps: <CODE>emacs_standard_keymap</CODE>,
<CODE>emacs_meta_keymap</CODE>, <CODE>emacs_ctlx_keymap</CODE>,
<CODE>vi_movement_keymap</CODE>, and <CODE>vi_insertion_keymap</CODE>.
<CODE>emacs_standard_keymap</CODE> is the default, and the examples in
this manual assume that.

</P>
<P>
Since <CODE>readline</CODE> installs a set of default key bindings the first
time it is called, there is always the danger that a custom binding
installed before the first call to <CODE>readline</CODE> will be overridden.
An alternate mechanism is to install custom key bindings in an
initialization function assigned to the <CODE>rl_startup_hook</CODE> variable
(see section <A HREF="readline.html#SEC28">Readline Variables</A>).

</P>
<P>
These functions manage key bindings.

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_bind_key</B> <I>(int key, Function *function)</I>
<DD><A NAME="IDX129"></A>
Binds <VAR>key</VAR> to <VAR>function</VAR> in the currently active keymap.
Returns non-zero in the case of an invalid <VAR>key</VAR>.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_bind_key_in_map</B> <I>(int key, Function *function, Keymap map)</I>
<DD><A NAME="IDX130"></A>
Bind <VAR>key</VAR> to <VAR>function</VAR> in <VAR>map</VAR>.  Returns non-zero in the case
of an invalid <VAR>key</VAR>.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_unbind_key</B> <I>(int key)</I>
<DD><A NAME="IDX131"></A>
Bind <VAR>key</VAR> to the null function in the currently active keymap.
Returns non-zero in case of error.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_unbind_key_in_map</B> <I>(int key, Keymap map)</I>
<DD><A NAME="IDX132"></A>
Bind <VAR>key</VAR> to the null function in <VAR>map</VAR>.
Returns non-zero in case of error.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_unbind_function_in_map</B> <I>(Function *function, Keymap map)</I>
<DD><A NAME="IDX133"></A>
Unbind all keys that execute <VAR>function</VAR> in <VAR>map</VAR>.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_unbind_command_in_map</B> <I>(char *command, Keymap map)</I>
<DD><A NAME="IDX134"></A>
Unbind all keys that are bound to <VAR>command</VAR> in <VAR>map</VAR>.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_generic_bind</B> <I>(int type, char *keyseq, char *data, Keymap map)</I>
<DD><A NAME="IDX135"></A>
Bind the key sequence represented by the string <VAR>keyseq</VAR> to the arbitrary
pointer <VAR>data</VAR>.  <VAR>type</VAR> says what kind of data is pointed to by
<VAR>data</VAR>; this can be a function (<CODE>ISFUNC</CODE>), a macro
(<CODE>ISMACR</CODE>), or a keymap (<CODE>ISKMAP</CODE>).  This makes new keymaps as
necessary.  The initial keymap in which to do bindings is <VAR>map</VAR>.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_parse_and_bind</B> <I>(char *line)</I>
<DD><A NAME="IDX136"></A>
Parse <VAR>line</VAR> as if it had been read from the <CODE>inputrc</CODE> file and
perform any key bindings and variable assignments found
(see section <A HREF="readline.html#SEC9">Readline Init File</A>).
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_read_init_file</B> <I>(char *filename)</I>
<DD><A NAME="IDX137"></A>
Read keybindings and variable assignments from <VAR>filename</VAR>
(see section <A HREF="readline.html#SEC9">Readline Init File</A>).
</DL>

</P>


<H3><A NAME="SEC33" HREF="readline.html#TOC33">Associating Function Names and Bindings</A></H3>

<P>
These functions allow you to find out what keys invoke named functions
and the functions invoked by a particular key sequence.

</P>
<P>
<DL>
<DT><U>Function:</U> Function * <B>rl_named_function</B> <I>(char *name)</I>
<DD><A NAME="IDX138"></A>
Return the function with name <VAR>name</VAR>.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> Function * <B>rl_function_of_keyseq</B> <I>(char *keyseq, Keymap map, int *type)</I>
<DD><A NAME="IDX139"></A>
Return the function invoked by <VAR>keyseq</VAR> in keymap <VAR>map</VAR>.
If <VAR>map</VAR> is NULL, the current keymap is used.  If <VAR>type</VAR> is
not NULL, the type of the object is returned in it (one of <CODE>ISFUNC</CODE>,
<CODE>ISKMAP</CODE>, or <CODE>ISMACR</CODE>).
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> char ** <B>rl_invoking_keyseqs</B> <I>(Function *function)</I>
<DD><A NAME="IDX140"></A>
Return an array of strings representing the key sequences used to
invoke <VAR>function</VAR> in the current keymap.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> char ** <B>rl_invoking_keyseqs_in_map</B> <I>(Function *function, Keymap map)</I>
<DD><A NAME="IDX141"></A>
Return an array of strings representing the key sequences used to
invoke <VAR>function</VAR> in the keymap <VAR>map</VAR>.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> void <B>rl_function_dumper</B> <I>(int readable)</I>
<DD><A NAME="IDX142"></A>
Print the readline function names and the key sequences currently
bound to them to <CODE>rl_outstream</CODE>.  If <VAR>readable</VAR> is non-zero,
the list is formatted in such a way that it can be made part of an
<CODE>inputrc</CODE> file and re-read.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> void <B>rl_list_funmap_names</B> <I>()</I>
<DD><A NAME="IDX143"></A>
Print the names of all bindable Readline functions to <CODE>rl_outstream</CODE>.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> char ** <B>rl_funmap_names</B> <I>()</I>
<DD><A NAME="IDX144"></A>
Return a NULL terminated array of known function names.  The array is
sorted.  The array itself is allocated, but not the strings inside.  You
should free () the array when you done, but not the pointrs.
</DL>

</P>


<H3><A NAME="SEC34" HREF="readline.html#TOC34">Allowing Undoing</A></H3>

<P>
Supporting the undo command is a painless thing, and makes your
functions much more useful.  It is certainly easy to try
something if you know you can undo it.  I could use an undo function for
the stock market.

</P>
<P>
If your function simply inserts text once, or deletes text once, and
uses <CODE>rl_insert_text ()</CODE> or <CODE>rl_delete_text ()</CODE> to do it, then
undoing is already done for you automatically.

</P>
<P>
If you do multiple insertions or multiple deletions, or any combination
of these operations, you should group them together into one operation.
This is done with <CODE>rl_begin_undo_group ()</CODE> and
<CODE>rl_end_undo_group ()</CODE>.

</P>
<P>
The types of events that can be undone are:

</P>

<PRE>
enum undo_code { UNDO_DELETE, UNDO_INSERT, UNDO_BEGIN, UNDO_END }; 
</PRE>

<P>
Notice that <CODE>UNDO_DELETE</CODE> means to insert some text, and
<CODE>UNDO_INSERT</CODE> means to delete some text.  That is, the undo code
tells undo what to undo, not how to undo it.  <CODE>UNDO_BEGIN</CODE> and
<CODE>UNDO_END</CODE> are tags added by <CODE>rl_begin_undo_group ()</CODE> and
<CODE>rl_end_undo_group ()</CODE>.

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_begin_undo_group</B> <I>()</I>
<DD><A NAME="IDX145"></A>
Begins saving undo information in a group construct.  The undo
information usually comes from calls to <CODE>rl_insert_text ()</CODE> and
<CODE>rl_delete_text ()</CODE>, but could be the result of calls to
<CODE>rl_add_undo ()</CODE>.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_end_undo_group</B> <I>()</I>
<DD><A NAME="IDX146"></A>
Closes the current undo group started with <CODE>rl_begin_undo_group
()</CODE>.  There should be one call to <CODE>rl_end_undo_group ()</CODE>
for each call to <CODE>rl_begin_undo_group ()</CODE>.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> void <B>rl_add_undo</B> <I>(enum undo_code what, int start, int end, char *text)</I>
<DD><A NAME="IDX147"></A>
Remember how to undo an event (according to <VAR>what</VAR>).  The affected
text runs from <VAR>start</VAR> to <VAR>end</VAR>, and encompasses <VAR>text</VAR>.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> void <B>free_undo_list</B> <I>()</I>
<DD><A NAME="IDX148"></A>
Free the existing undo list.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_do_undo</B> <I>()</I>
<DD><A NAME="IDX149"></A>
Undo the first thing on the undo list.  Returns <CODE>0</CODE> if there was
nothing to undo, non-zero if something was undone.
</DL>

</P>
<P>
Finally, if you neither insert nor delete text, but directly modify the
existing text (e.g., change its case), call <CODE>rl_modifying ()</CODE>
once, just before you modify the text.  You must supply the indices of
the text range that you are going to modify.

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_modifying</B> <I>(int start, int end)</I>
<DD><A NAME="IDX150"></A>
Tell Readline to save the text between <VAR>start</VAR> and <VAR>end</VAR> as a
single undo unit.  It is assumed that you will subsequently modify
that text.
</DL>

</P>


<H3><A NAME="SEC35" HREF="readline.html#TOC35">Redisplay</A></H3>

<P>
<DL>
<DT><U>Function:</U> void <B>rl_redisplay</B> <I>()</I>
<DD><A NAME="IDX151"></A>
Change what's displayed on the screen to reflect the current contents
of <CODE>rl_line_buffer</CODE>.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_forced_update_display</B> <I>()</I>
<DD><A NAME="IDX152"></A>
Force the line to be updated and redisplayed, whether or not
Readline thinks the screen display is correct.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_on_new_line</B> <I>()</I>
<DD><A NAME="IDX153"></A>
Tell the update functions that we have moved onto a new (empty) line,
usually after ouputting a newline.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_on_new_line_with_prompt</B> <I>()</I>
<DD><A NAME="IDX154"></A>
Tell the update functions that we have moved onto a new line, with
<VAR>rl_prompt</VAR> already displayed.
This could be used by applications that want to output the prompt string
themselves, but still need Readline to know the prompt string length for
redisplay.
It should be used after setting <VAR>rl_already_prompted</VAR>.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_reset_line_state</B> <I>()</I>
<DD><A NAME="IDX155"></A>
Reset the display state to a clean state and redisplay the current line
starting on a new line.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_message</B> <I>(va_alist)</I>
<DD><A NAME="IDX156"></A>
The arguments are a string as would be supplied to <CODE>printf</CODE>.  The
resulting string is displayed in the <EM>echo area</EM>.  The echo area
is also used to display numeric arguments and search strings.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_clear_message</B> <I>()</I>
<DD><A NAME="IDX157"></A>
Clear the message in the echo area.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> void <B>rl_save_prompt</B> <I>()</I>
<DD><A NAME="IDX158"></A>
Save the local Readline prompt display state in preparation for
displaying a new message in the message area with <CODE>rl_message</CODE>.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> void <B>rl_restore_prompt</B> <I>()</I>
<DD><A NAME="IDX159"></A>
Restore the local Readline prompt display state saved by the most
recent call to <CODE>rl_save_prompt</CODE>.
</DL>

</P>


<H3><A NAME="SEC36" HREF="readline.html#TOC36">Modifying Text</A></H3>

<P>
<DL>
<DT><U>Function:</U> int <B>rl_insert_text</B> <I>(char *text)</I>
<DD><A NAME="IDX160"></A>
Insert <VAR>text</VAR> into the line at the current cursor position.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_delete_text</B> <I>(int start, int end)</I>
<DD><A NAME="IDX161"></A>
Delete the text between <VAR>start</VAR> and <VAR>end</VAR> in the current line.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> char * <B>rl_copy_text</B> <I>(int start, int end)</I>
<DD><A NAME="IDX162"></A>
Return a copy of the text between <VAR>start</VAR> and <VAR>end</VAR> in
the current line.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_kill_text</B> <I>(int start, int end)</I>
<DD><A NAME="IDX163"></A>
Copy the text between <VAR>start</VAR> and <VAR>end</VAR> in the current line
to the kill ring, appending or prepending to the last kill if the
last command was a kill command.  The text is deleted.
If <VAR>start</VAR> is less than <VAR>end</VAR>,
the text is appended, otherwise prepended.  If the last command was
not a kill, a new kill ring slot is used.
</DL>

</P>


<H3><A NAME="SEC37" HREF="readline.html#TOC37">Utility Functions</A></H3>

<P>
<DL>
<DT><U>Function:</U> int <B>rl_read_key</B> <I>()</I>
<DD><A NAME="IDX164"></A>
Return the next character available.  This handles input inserted into
the input stream via <VAR>pending input</VAR> (see section <A HREF="readline.html#SEC28">Readline Variables</A>)
and <CODE>rl_stuff_char ()</CODE>, macros, and characters read from the keyboard.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_getc</B> <I>(FILE *)</I>
<DD><A NAME="IDX165"></A>
Return the next character available from the keyboard.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_stuff_char</B> <I>(int c)</I>
<DD><A NAME="IDX166"></A>
Insert <VAR>c</VAR> into the Readline input stream.  It will be "read"
before Readline attempts to read characters from the terminal with
<CODE>rl_read_key ()</CODE>.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_extend_line_buffer</B> <I>(int len)</I>
<DD><A NAME="IDX167"></A>
Ensure that <CODE>rl_line_buffer</CODE> has enough space to hold <VAR>len</VAR>
characters, possibly reallocating it if necessary.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_initialize</B> <I>()</I>
<DD><A NAME="IDX168"></A>
Initialize or re-initialize Readline's internal state.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_reset_terminal</B> <I>(char *terminal_name)</I>
<DD><A NAME="IDX169"></A>
Reinitialize Readline's idea of the terminal settings using
<VAR>terminal_name</VAR> as the terminal type (e.g., <CODE>vt100</CODE>).
If <VAR>terminal_name</VAR> is NULL, the value of the <CODE>TERM</CODE>
environment variable is used.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>alphabetic</B> <I>(int c)</I>
<DD><A NAME="IDX170"></A>
Return 1 if <VAR>c</VAR> is an alphabetic character.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>numeric</B> <I>(int c)</I>
<DD><A NAME="IDX171"></A>
Return 1 if <VAR>c</VAR> is a numeric character.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>ding</B> <I>()</I>
<DD><A NAME="IDX172"></A>
Ring the terminal bell, obeying the setting of <CODE>bell-style</CODE>.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> void <B>rl_display_match_list</B> <I>(char **matches, int len, int max)</I>
<DD><A NAME="IDX173"></A>
A convenience function for displaying a list of strings in
columnar format on Readline's output stream.  <CODE>matches</CODE> is the list
of strings, in argv format, such as a list of completion matches.
<CODE>len</CODE> is the number of strings in <CODE>matches</CODE>, and <CODE>max</CODE>
is the length of the longest string in <CODE>matches</CODE>.  This function uses
the setting of <CODE>print-completions-horizontally</CODE> to select how the
matches are displayed (see section <A HREF="readline.html#SEC10">Readline Init File Syntax</A>).
</DL>

</P>
<P>
The following are implemented as macros, defined in <CODE>chartypes.h</CODE>.

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>uppercase_p</B> <I>(int c)</I>
<DD><A NAME="IDX174"></A>
Return 1 if <VAR>c</VAR> is an uppercase alphabetic character.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>lowercase_p</B> <I>(int c)</I>
<DD><A NAME="IDX175"></A>
Return 1 if <VAR>c</VAR> is a lowercase alphabetic character.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>digit_p</B> <I>(int c)</I>
<DD><A NAME="IDX176"></A>
Return 1 if <VAR>c</VAR> is a numeric character.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>to_upper</B> <I>(int c)</I>
<DD><A NAME="IDX177"></A>
If <VAR>c</VAR> is a lowercase alphabetic character, return the corresponding
uppercase character.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>to_lower</B> <I>(int c)</I>
<DD><A NAME="IDX178"></A>
If <VAR>c</VAR> is an uppercase alphabetic character, return the corresponding
lowercase character.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>digit_value</B> <I>(int c)</I>
<DD><A NAME="IDX179"></A>
If <VAR>c</VAR> is a number, return the value it represents.
</DL>

</P>


<H3><A NAME="SEC38" HREF="readline.html#TOC38">Alternate Interface</A></H3>

<P>
An alternate interface is available to plain <CODE>readline()</CODE>.  Some
applications need to interleave keyboard I/O with file, device, or
window system I/O, typically by using a main loop to <CODE>select()</CODE>
on various file descriptors.  To accomodate this need, readline can
also be invoked as a `callback' function from an event loop.  There
are functions available to make this easy.

</P>
<P>
<DL>
<DT><U>Function:</U> void <B>rl_callback_handler_install</B> <I>(char *prompt, Vfunction *lhandler)</I>
<DD><A NAME="IDX180"></A>
Set up the terminal for readline I/O and display the initial
expanded value of <VAR>prompt</VAR>.  Save the value of <VAR>lhandler</VAR> to
use as a callback when a complete line of input has been entered.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> void <B>rl_callback_read_char</B> <I>()</I>
<DD><A NAME="IDX181"></A>
Whenever an application determines that keyboard input is available, it
should call <CODE>rl_callback_read_char()</CODE>, which will read the next
character from the current input source.  If that character completes the
line, <CODE>rl_callback_read_char</CODE> will invoke the <VAR>lhandler</VAR>
function saved by <CODE>rl_callback_handler_install</CODE> to process the
line.  <CODE>EOF</CODE> is  indicated by calling <VAR>lhandler</VAR> with a
<CODE>NULL</CODE> line.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> void <B>rl_callback_handler_remove</B> <I>()</I>
<DD><A NAME="IDX182"></A>
Restore the terminal to its initial state and remove the line handler.
This may be called from within a callback as well as independently.
</DL>

</P>


<H3><A NAME="SEC39" HREF="readline.html#TOC39">An Example</A></H3>

<P>
Here is a function which changes lowercase characters to their uppercase
equivalents, and uppercase characters to lowercase.  If
this function was bound to <SAMP>`M-c'</SAMP>, then typing <SAMP>`M-c'</SAMP> would
change the case of the character under point.  Typing <SAMP>`M-1 0 M-c'</SAMP>
would change the case of the following 10 characters, leaving the cursor on
the last character changed.

</P>

<PRE>
/* Invert the case of the COUNT following characters. */
int
invert_case_line (count, key)
     int count, key;
{
  register int start, end, i;

  start = rl_point;

  if (rl_point &#62;= rl_end)
    return (0);

  if (count &#60; 0)
    {
      direction = -1;
      count = -count;
    }
  else
    direction = 1;
      
  /* Find the end of the range to modify. */
  end = start + (count * direction);

  /* Force it to be within range. */
  if (end &#62; rl_end)
    end = rl_end;
  else if (end &#60; 0)
    end = 0;

  if (start == end)
    return (0);

  if (start &#62; end)
    {
      int temp = start;
      start = end;
      end = temp;
    }

  /* Tell readline that we are modifying the line, so it will save
     the undo information. */
  rl_modifying (start, end);

  for (i = start; i != end; i++)
    {
      if (uppercase_p (rl_line_buffer[i]))
        rl_line_buffer[i] = to_lower (rl_line_buffer[i]);
      else if (lowercase_p (rl_line_buffer[i]))
        rl_line_buffer[i] = to_upper (rl_line_buffer[i]);
    }
  /* Move point to on top of the last character changed. */
  rl_point = (direction == 1) ? end - 1 : start;
  return (0);
}
</PRE>



<H2><A NAME="SEC40" HREF="readline.html#TOC40">Readline Signal Handling</A></H2>

<P>
Signals are asynchronous events sent to a process by the Unix kernel,
sometimes on behalf of another process.  They are intended to indicate
exceptional events, like a user pressing the interrupt key on his
terminal, or a network connection being broken.  There is a class of
signals that can be sent to the process currently reading input from
the keyboard.  Since Readline changes the terminal attributes when it
is called, it needs to perform special processing when a signal is
received to restore the terminal to a sane state, or provide application
writers with functions to do so manually.

</P>
<P>
Readline contains an internal signal handler that is installed for a
number of signals (<CODE>SIGINT</CODE>, <CODE>SIGQUIT</CODE>, <CODE>SIGTERM</CODE>,
<CODE>SIGALRM</CODE>, <CODE>SIGTSTP</CODE>, <CODE>SIGTTIN</CODE>, and <CODE>SIGTTOU</CODE>).
When one of these signals is received, the signal handler
will reset the terminal attributes to those that were in effect before
<CODE>readline ()</CODE> was called, reset the signal handling to what it was
before <CODE>readline ()</CODE> was called, and resend the signal to the calling
application.
If and when the calling application's signal handler returns, Readline
will reinitialize the terminal and continue to accept input.
When a <CODE>SIGINT</CODE> is received, the Readline signal handler performs
some additional work, which will cause any partially-entered line to be
aborted (see the description of <CODE>rl_free_line_state ()</CODE>).

</P>
<P>
There is an additional Readline signal handler, for <CODE>SIGWINCH</CODE>, which
the kernel sends to a process whenever the terminal's size changes (for
example, if a user resizes an <CODE>xterm</CODE>).  The Readline <CODE>SIGWINCH</CODE>
handler updates Readline's internal screen size state, and then calls any
<CODE>SIGWINCH</CODE> signal handler the calling application has installed. 
Readline calls the application's <CODE>SIGWINCH</CODE> signal handler without
resetting the terminal to its original state.  If the application's signal
handler does more than update its idea of the terminal size and return (for
example, a <CODE>longjmp</CODE> back to a main processing loop), it <EM>must</EM>
call <CODE>rl_cleanup_after_signal ()</CODE> (described below), to restore the
terminal state. 

</P>
<P>
Readline provides two variables that allow application writers to
control whether or not it will catch certain signals and act on them
when they are received.  It is important that applications change the
values of these variables only when calling <CODE>readline ()</CODE>, not in
a signal handler, so Readline's internal signal state is not corrupted.

</P>
<P>
<DL>
<DT><U>Variable:</U> int <B>rl_catch_signals</B>
<DD><A NAME="IDX183"></A>
If this variable is non-zero, Readline will install signal handlers for
<CODE>SIGINT</CODE>, <CODE>SIGQUIT</CODE>, <CODE>SIGTERM</CODE>, <CODE>SIGALRM</CODE>,
<CODE>SIGTSTP</CODE>, <CODE>SIGTTIN</CODE>, and <CODE>SIGTTOU</CODE>.

</P>
<P>
The default value of <CODE>rl_catch_signals</CODE> is 1.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> int <B>rl_catch_sigwinch</B>
<DD><A NAME="IDX184"></A>
If this variable is non-zero, Readline will install a signal handler for
<CODE>SIGWINCH</CODE>.

</P>
<P>
The default value of <CODE>rl_catch_sigwinch</CODE> is 1.
</DL>

</P>
<P>
If an application does not wish to have Readline catch any signals, or
to handle signals other than those Readline catches (<CODE>SIGHUP</CODE>,
for example), 
Readline provides convenience functions to do the necessary terminal
and internal state cleanup upon receipt of a signal.

</P>
<P>
<DL>
<DT><U>Function:</U> void <B>rl_cleanup_after_signal</B> <I>(void)</I>
<DD><A NAME="IDX185"></A>
This function will reset the state of the terminal to what it was before
<CODE>readline ()</CODE> was called, and remove the Readline signal handlers for
all signals, depending on the values of <CODE>rl_catch_signals</CODE> and
<CODE>rl_catch_sigwinch</CODE>.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> void <B>rl_free_line_state</B> <I>(void)</I>
<DD><A NAME="IDX186"></A>
This will free any partial state associated with the current input line
(undo information, any partial history entry, any partially-entered
keyboard macro, and any partially-entered numeric argument).  This
should be called before <CODE>rl_cleanup_after_signal ()</CODE>.  The
Readline signal handler for <CODE>SIGINT</CODE> calls this to abort the
current input line.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> void <B>rl_reset_after_signal</B> <I>(void)</I>
<DD><A NAME="IDX187"></A>
This will reinitialize the terminal and reinstall any Readline signal
handlers, depending on the values of <CODE>rl_catch_signals</CODE> and
<CODE>rl_catch_sigwinch</CODE>.
</DL>

</P>
<P>
If an application does not wish Readline to catch <CODE>SIGWINCH</CODE>, it may
call <CODE>rl_resize_terminal ()</CODE> to force Readline to update its idea of
the terminal size when a <CODE>SIGWINCH</CODE> is received.

</P>
<P>
<DL>
<DT><U>Function:</U> void <B>rl_resize_terminal</B> <I>(void)</I>
<DD><A NAME="IDX188"></A>
Update Readline's internal screen size.
</DL>

</P>
<P>
The following functions install and remove Readline's signal handlers.

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_set_signals</B> <I>(void)</I>
<DD><A NAME="IDX189"></A>
Install Readline's signal handler for <CODE>SIGINT</CODE>, <CODE>SIGQUIT</CODE>,
<CODE>SIGTERM</CODE>, <CODE>SIGALRM</CODE>, <CODE>SIGTSTP</CODE>, <CODE>SIGTTIN</CODE>,
<CODE>SIGTTOU</CODE>, and <CODE>SIGWINCH</CODE>, depending on the values of
<CODE>rl_catch_signals</CODE> and <CODE>rl_catch_sigwinch</CODE>.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_clear_signals</B> <I>(void)</I>
<DD><A NAME="IDX190"></A>
Remove all of the Readline signal handlers installed by
<CODE>rl_set_signals ()</CODE>.
</DL>

</P>


<H2><A NAME="SEC41" HREF="readline.html#TOC41">Custom Completers</A></H2>

<P>
Typically, a program that reads commands from the user has a way of
disambiguating commands and data.  If your program is one of these, then
it can provide completion for commands, data, or both.
The following sections describe how your program and Readline
cooperate to provide this service.

</P>

<UL>
<LI><A HREF="readline.html#SEC42">How Completing Works</A>: The logic used to do completion.
<LI><A HREF="readline.html#SEC43">Completion Functions</A>: Functions provided by Readline.
<LI><A HREF="readline.html#SEC44">Completion Variables</A>: Variables which control completion.
<LI><A HREF="readline.html#SEC45">A Short Completion Example</A>: An example of writing completer subroutines.
</UL>



<H3><A NAME="SEC42" HREF="readline.html#TOC42">How Completing Works</A></H3>

<P>
In order to complete some text, the full list of possible completions
must be available.  That is, it is not possible to accurately
expand a partial word without knowing all of the possible words
which make sense in that context.  The Readline library provides
the user interface to completion, and two of the most common
completion functions:  filename and username.  For completing other types
of text, you must write your own completion function.  This section
describes exactly what such functions must do, and provides an example.

</P>
<P>
There are three major functions used to perform completion:

</P>

<OL>
<LI>

The user-interface function <CODE>rl_complete ()</CODE>.  This function is
called with the same arguments as other Readline
functions intended for interactive use:  <VAR>count</VAR> and
<VAR>invoking_key</VAR>.  It isolates the word to be completed and calls
<CODE>completion_matches ()</CODE> to generate a list of possible completions.
It then either lists the possible completions, inserts the possible
completions, or actually performs the
completion, depending on which behavior is desired.

<LI>

The internal function <CODE>completion_matches ()</CODE> uses your
<EM>generator</EM> function to generate the list of possible matches, and
then returns the array of these matches.  You should place the address
of your generator function in <CODE>rl_completion_entry_function</CODE>.

<LI>

The generator function is called repeatedly from
<CODE>completion_matches ()</CODE>, returning a string each time.  The
arguments to the generator function are <VAR>text</VAR> and <VAR>state</VAR>.
<VAR>text</VAR> is the partial word to be completed.  <VAR>state</VAR> is zero the
first time the function is called, allowing the generator to perform
any necessary initialization, and a positive non-zero integer for
each subsequent call.  When the generator function returns
<CODE>(char *)NULL</CODE> this signals <CODE>completion_matches ()</CODE> that there are
no more possibilities left.  Usually the generator function computes the
list of possible completions when <VAR>state</VAR> is zero, and returns them
one at a time on subsequent calls.  Each string the generator function
returns as a match must be allocated with <CODE>malloc()</CODE>; Readline
frees the strings when it has finished with them.

</OL>

<P>
<DL>
<DT><U>Function:</U> int <B>rl_complete</B> <I>(int ignore, int invoking_key)</I>
<DD><A NAME="IDX191"></A>
Complete the word at or before point.  You have supplied the function
that does the initial simple matching selection algorithm (see
<CODE>completion_matches ()</CODE>).  The default is to do filename completion.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> Function * <B>rl_completion_entry_function</B>
<DD><A NAME="IDX192"></A>
This is a pointer to the generator function for <CODE>completion_matches
()</CODE>.  If the value of <CODE>rl_completion_entry_function</CODE> is
<CODE>(Function *)NULL</CODE> then the default filename generator function,
<CODE>filename_completion_function ()</CODE>, is used.
</DL>

</P>


<H3><A NAME="SEC43" HREF="readline.html#TOC43">Completion Functions</A></H3>

<P>
Here is the complete list of callable completion functions present in
Readline.

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_complete_internal</B> <I>(int what_to_do)</I>
<DD><A NAME="IDX193"></A>
Complete the word at or before point.  <VAR>what_to_do</VAR> says what to do
with the completion.  A value of <SAMP>`?'</SAMP> means list the possible
completions.  <SAMP>`TAB'</SAMP> means do standard completion.  <SAMP>`*'</SAMP> means
insert all of the possible completions.  <SAMP>`!'</SAMP> means to display
all of the possible completions, if there is more than one, as well as
performing partial completion.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_complete</B> <I>(int ignore, int invoking_key)</I>
<DD><A NAME="IDX194"></A>
Complete the word at or before point.  You have supplied the function
that does the initial simple matching selection algorithm (see
<CODE>completion_matches ()</CODE> and <CODE>rl_completion_entry_function</CODE>).
The default is to do filename
completion.  This calls <CODE>rl_complete_internal ()</CODE> with an
argument depending on <VAR>invoking_key</VAR>.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_possible_completions</B> <I>(int count, int invoking_key))</I>
<DD><A NAME="IDX195"></A>
List the possible completions.  See description of <CODE>rl_complete
()</CODE>.  This calls <CODE>rl_complete_internal ()</CODE> with an argument of
<SAMP>`?'</SAMP>.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> int <B>rl_insert_completions</B> <I>(int count, int invoking_key))</I>
<DD><A NAME="IDX196"></A>
Insert the list of possible completions into the line, deleting the
partially-completed word.  See description of <CODE>rl_complete ()</CODE>.
This calls <CODE>rl_complete_internal ()</CODE> with an argument of <SAMP>`*'</SAMP>.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> char ** <B>completion_matches</B> <I>(char *text, CPFunction *entry_func)</I>
<DD><A NAME="IDX197"></A>
Returns an array of <CODE>(char *)</CODE> which is a list of completions for
<VAR>text</VAR>.  If there are no completions, returns <CODE>(char **)NULL</CODE>.
The first entry in the returned array is the substitution for <VAR>text</VAR>.
The remaining entries are the possible completions.  The array is
terminated with a <CODE>NULL</CODE> pointer.

</P>
<P>
<VAR>entry_func</VAR> is a function of two args, and returns a
<CODE>(char *)</CODE>.  The first argument is <VAR>text</VAR>.  The second is a
state argument; it is zero on the first call, and non-zero on subsequent
calls.  <VAR>entry_func</VAR> returns a <CODE>NULL</CODE>  pointer to the caller
when there are no more matches.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> char * <B>filename_completion_function</B> <I>(char *text, int state)</I>
<DD><A NAME="IDX198"></A>
A generator function for filename completion in the general case.  Note
that completion in Bash is a little different because of all
the pathnames that must be followed when looking up completions for a
command.  The Bash source is a useful reference for writing custom
completion functions.
</DL>

</P>
<P>
<DL>
<DT><U>Function:</U> char * <B>username_completion_function</B> <I>(char *text, int state)</I>
<DD><A NAME="IDX199"></A>
A completion generator for usernames.  <VAR>text</VAR> contains a partial
username preceded by a random character (usually <SAMP>`~'</SAMP>).  As with all
completion generators, <VAR>state</VAR> is zero on the first call and non-zero
for subsequent calls.
</DL>

</P>


<H3><A NAME="SEC44" HREF="readline.html#TOC44">Completion Variables</A></H3>

<P>
<DL>
<DT><U>Variable:</U> Function * <B>rl_completion_entry_function</B>
<DD><A NAME="IDX200"></A>
A pointer to the generator function for <CODE>completion_matches ()</CODE>.
<CODE>NULL</CODE> means to use <CODE>filename_completion_function ()</CODE>, the default
filename completer.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> CPPFunction * <B>rl_attempted_completion_function</B>
<DD><A NAME="IDX201"></A>
A pointer to an alternative function to create matches.
The function is called with <VAR>text</VAR>, <VAR>start</VAR>, and <VAR>end</VAR>.
<VAR>start</VAR> and <VAR>end</VAR> are indices in <CODE>rl_line_buffer</CODE> saying
what the boundaries of <VAR>text</VAR> are.  If this function exists and
returns <CODE>NULL</CODE>, or if this variable is set to <CODE>NULL</CODE>, then
<CODE>rl_complete ()</CODE> will call the value of
<CODE>rl_completion_entry_function</CODE> to generate matches, otherwise the
array of strings returned will be used.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> CPFunction * <B>rl_filename_quoting_function</B>
<DD><A NAME="IDX202"></A>
A pointer to a function that will quote a filename in an application-
specific fashion.  This is called if filename completion is being
attempted and one of the characters in <CODE>rl_filename_quote_characters</CODE>
appears in a completed filename.  The function is called with
<VAR>text</VAR>, <VAR>match_type</VAR>, and <VAR>quote_pointer</VAR>.  The <VAR>text</VAR>
is the filename to be quoted.  The <VAR>match_type</VAR> is either
<CODE>SINGLE_MATCH</CODE>, if there is only one completion match, or
<CODE>MULT_MATCH</CODE>.  Some functions use this to decide whether or not to
insert a closing quote character.  The <VAR>quote_pointer</VAR> is a pointer
to any opening quote character the user typed.  Some functions choose
to reset this character.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> CPFunction * <B>rl_filename_dequoting_function</B>
<DD><A NAME="IDX203"></A>
A pointer to a function that will remove application-specific quoting
characters from a filename before completion is attempted, so those
characters do not interfere with matching the text against names in
the filesystem.  It is called with <VAR>text</VAR>, the text of the word
to be dequoted, and <VAR>quote_char</VAR>, which is the quoting character 
that delimits the filename (usually <SAMP>`''</SAMP> or <SAMP>`"'</SAMP>).  If
<VAR>quote_char</VAR> is zero, the filename was not in an embedded string.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> Function * <B>rl_char_is_quoted_p</B>
<DD><A NAME="IDX204"></A>
A pointer to a function to call that determines whether or not a specific
character in the line buffer is quoted, according to whatever quoting
mechanism the program calling readline uses.  The function is called with
two arguments: <VAR>text</VAR>, the text of the line, and <VAR>index</VAR>, the
index of the character in the line.  It is used to decide whether a
character found in <CODE>rl_completer_word_break_characters</CODE> should be
used to break words for the completer.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> int <B>rl_completion_query_items</B>
<DD><A NAME="IDX205"></A>
Up to this many items will be displayed in response to a
possible-completions call.  After that, we ask the user if she is sure
she wants to see them all.  The default value is 100.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> char * <B>rl_basic_word_break_characters</B>
<DD><A NAME="IDX206"></A>
The basic list of characters that signal a break between words for the
completer routine.  The default value of this variable is the characters
which break words for completion in Bash, i.e.,
<CODE>" \t\n\"\\'`@$&#62;&#60;=;|&#38;{("</CODE>.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> char * <B>rl_basic_quote_characters</B>
<DD><A NAME="IDX207"></A>
List of quote characters which can cause a word break.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> char * <B>rl_completer_word_break_characters</B>
<DD><A NAME="IDX208"></A>
The list of characters that signal a break between words for
<CODE>rl_complete_internal ()</CODE>.  The default list is the value of
<CODE>rl_basic_word_break_characters</CODE>.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> char * <B>rl_completer_quote_characters</B>
<DD><A NAME="IDX209"></A>
List of characters which can be used to quote a substring of the line.
Completion occurs on the entire substring, and within the substring
<CODE>rl_completer_word_break_characters</CODE> are treated as any other character,
unless they also appear within this list.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> char * <B>rl_filename_quote_characters</B>
<DD><A NAME="IDX210"></A>
A list of characters that cause a filename to be quoted by the completer
when they appear in a completed filename.  The default is the null string.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> char * <B>rl_special_prefixes</B>
<DD><A NAME="IDX211"></A>
The list of characters that are word break characters, but should be
left in <VAR>text</VAR> when it is passed to the completion function.
Programs can use this to help determine what kind of completing to do.
For instance, Bash sets this variable to "$@" so that it can complete
shell variables and hostnames.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> int <B>rl_completion_append_character</B>
<DD><A NAME="IDX212"></A>
When a single completion alternative matches at the end of the command
line, this character is appended to the inserted completion text.  The
default is a space character (<SAMP>` '</SAMP>).  Setting this to the null
character (<SAMP>`\0'</SAMP>) prevents anything being appended automatically.
This can be changed in custom completion functions to
provide the "most sensible word separator character" according to
an application-specific command line syntax specification.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> int <B>rl_ignore_completion_duplicates</B>
<DD><A NAME="IDX213"></A>
If non-zero, then disallow duplicates in the matches.  Default is 1.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> int <B>rl_filename_completion_desired</B>
<DD><A NAME="IDX214"></A>
Non-zero means that the results of the matches are to be treated as
filenames.  This is <EM>always</EM> zero on entry, and can only be changed
within a completion entry generator function.  If it is set to a non-zero
value, directory names have a slash appended and Readline attempts to
quote completed filenames if they contain any embedded word break
characters.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> int <B>rl_filename_quoting_desired</B>
<DD><A NAME="IDX215"></A>
Non-zero means that the results of the matches are to be quoted using
double quotes (or an application-specific quoting mechanism) if the
completed filename contains any characters in
<CODE>rl_filename_quote_chars</CODE>.  This is <EM>always</EM> non-zero
on entry, and can only be changed within a completion entry generator
function.  The quoting is effected via a call to the function pointed to
by <CODE>rl_filename_quoting_function</CODE>.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> int <B>rl_inhibit_completion</B>
<DD><A NAME="IDX216"></A>
If this variable is non-zero, completion is inhibit&#60;ed.  The completion
character will be inserted as any other bound to <CODE>self-insert</CODE>.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> Function * <B>rl_ignore_some_completions_function</B>
<DD><A NAME="IDX217"></A>
This function, if defined, is called by the completer when real filename
completion is done, after all the matching names have been generated.
It is passed a <CODE>NULL</CODE> terminated array of matches.
The first element (<CODE>matches[0]</CODE>) is the
maximal substring common to all matches. This function can
re-arrange the list of matches as required, but each element deleted
from the array must be freed.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> Function * <B>rl_directory_completion_hook</B>
<DD><A NAME="IDX218"></A>
This function, if defined, is allowed to modify the directory portion
of filenames Readline completes.  It is called with the address of a
string (the current directory name) as an argument.  It could be used
to expand symbolic links or shell variables in pathnames.
</DL>

</P>
<P>
<DL>
<DT><U>Variable:</U> VFunction * <B>rl_completion_display_matches_hook</B>
<DD><A NAME="IDX219"></A>
If non-zero, then this is the address of a function to call when
completing a word would normally display the list of possible matches.
This function is called in lieu of Readline displaying the list.
It takes three arguments:
(<CODE>char **</CODE><VAR>matches</VAR>, <CODE>int</CODE> <VAR>num_matches</VAR>, <CODE>int</CODE> <VAR>max_length</VAR>)
where <VAR>matches</VAR> is the array of matching strings,
<VAR>num_matches</VAR> is the number of strings in that array, and
<VAR>max_length</VAR> is the length of the longest string in that array.
Readline provides a convenience function, <CODE>rl_display_match_list</CODE>,
that takes care of doing the display to Readline's output stream.  That
function may be called from this hook.
</DL>

</P>


<H3><A NAME="SEC45" HREF="readline.html#TOC45">A Short Completion Example</A></H3>

<P>
Here is a small application demonstrating the use of the GNU Readline
library.  It is called <CODE>fileman</CODE>, and the source code resides in
<TT>`examples/fileman.c'</TT>.  This sample application provides
completion of command names, line editing features, and access to the
history list.

</P>

<PRE>
/* fileman.c -- A tiny application which demonstrates how to use the
   GNU Readline library.  This application interactively allows users
   to manipulate files and their modes. */

#include &#60;stdio.h&#62;
#include &#60;sys/types.h&#62;
#include &#60;sys/file.h&#62;
#include &#60;sys/stat.h&#62;
#include &#60;sys/errno.h&#62;

#include &#60;readline/readline.h&#62;
#include &#60;readline/history.h&#62;

extern char *getwd ();
extern char *xmalloc ();

/* The names of functions that actually do the manipulation. */
int com_list (), com_view (), com_rename (), com_stat (), com_pwd ();
int com_delete (), com_help (), com_cd (), com_quit ();

/* A structure which contains information on the commands this program
   can understand. */

typedef struct {
  char *name;			/* User printable name of the function. */
  Function *func;		/* Function to call to do the job. */
  char *doc;			/* Documentation for this function.  */
} COMMAND;

COMMAND commands[] = {
  { "cd", com_cd, "Change to directory DIR" },
  { "delete", com_delete, "Delete FILE" },
  { "help", com_help, "Display this text" },
  { "?", com_help, "Synonym for `help'" },
  { "list", com_list, "List files in DIR" },
  { "ls", com_list, "Synonym for `list'" },
  { "pwd", com_pwd, "Print the current working directory" },
  { "quit", com_quit, "Quit using Fileman" },
  { "rename", com_rename, "Rename FILE to NEWNAME" },
  { "stat", com_stat, "Print out statistics on FILE" },
  { "view", com_view, "View the contents of FILE" },
  { (char *)NULL, (Function *)NULL, (char *)NULL }
};

/* Forward declarations. */
char *stripwhite ();
COMMAND *find_command ();

/* The name of this program, as taken from argv[0]. */
char *progname;

/* When non-zero, this global means the user is done using this program. */
int done;

char *
dupstr (s)
     int s;
{
  char *r;

  r = xmalloc (strlen (s) + 1);
  strcpy (r, s);
  return (r);
}

main (argc, argv)
     int argc;
     char **argv;
{
  char *line, *s;

  progname = argv[0];

  initialize_readline ();	/* Bind our completer. */

  /* Loop reading and executing lines until the user quits. */
  for ( ; done == 0; )
    {
      line = readline ("FileMan: ");

      if (!line)
        break;

      /* Remove leading and trailing whitespace from the line.
         Then, if there is anything left, add it to the history list
         and execute it. */
      s = stripwhite (line);

      if (*s)
        {
          add_history (s);
          execute_line (s);
        }

      free (line);
    }
  exit (0);
}

/* Execute a command line. */
int
execute_line (line)
     char *line;
{
  register int i;
  COMMAND *command;
  char *word;

  /* Isolate the command word. */
  i = 0;
  while (line[i] &#38;&#38; whitespace (line[i]))
    i++;
  word = line + i;

  while (line[i] &#38;&#38; !whitespace (line[i]))
    i++;

  if (line[i])
    line[i++] = '\0';

  command = find_command (word);

  if (!command)
    {
      fprintf (stderr, "%s: No such command for FileMan.\n", word);
      return (-1);
    }

  /* Get argument to command, if any. */
  while (whitespace (line[i]))
    i++;

  word = line + i;

  /* Call the function. */
  return ((*(command-&#62;func)) (word));
}

/* Look up NAME as the name of a command, and return a pointer to that
   command.  Return a NULL pointer if NAME isn't a command name. */
COMMAND *
find_command (name)
     char *name;
{
  register int i;

  for (i = 0; commands[i].name; i++)
    if (strcmp (name, commands[i].name) == 0)
      return (&#38;commands[i]);

  return ((COMMAND *)NULL);
}

/* Strip whitespace from the start and end of STRING.  Return a pointer
   into STRING. */
char *
stripwhite (string)
     char *string;
{
  register char *s, *t;

  for (s = string; whitespace (*s); s++)
    ;
    
  if (*s == 0)
    return (s);

  t = s + strlen (s) - 1;
  while (t &#62; s &#38;&#38; whitespace (*t))
    t--;
  *++t = '\0';

  return s;
}

/* **************************************************************** */
/*                                                                  */
/*                  Interface to Readline Completion                */
/*                                                                  */
/* **************************************************************** */

char *command_generator ();
char **fileman_completion ();

/* Tell the GNU Readline library how to complete.  We want to try to complete
   on command names if this is the first word in the line, or on filenames
   if not. */
initialize_readline ()
{
  /* Allow conditional parsing of the ~/.inputrc file. */
  rl_readline_name = "FileMan";

  /* Tell the completer that we want a crack first. */
  rl_attempted_completion_function = (CPPFunction *)fileman_completion;
}

/* Attempt to complete on the contents of TEXT.  START and END bound the
   region of rl_line_buffer that contains the word to complete.  TEXT is
   the word to complete.  We can use the entire contents of rl_line_buffer
   in case we want to do some simple parsing.  Return the array of matches,
   or NULL if there aren't any. */
char **
fileman_completion (text, start, end)
     char *text;
     int start, end;
{
  char **matches;

  matches = (char **)NULL;

  /* If this word is at the start of the line, then it is a command
     to complete.  Otherwise it is the name of a file in the current
     directory. */
  if (start == 0)
    matches = completion_matches (text, command_generator);

  return (matches);
}

/* Generator function for command completion.  STATE lets us know whether
   to start from scratch; without any state (i.e. STATE == 0), then we
   start at the top of the list. */
char *
command_generator (text, state)
     char *text;
     int state;
{
  static int list_index, len;
  char *name;

  /* If this is a new word to complete, initialize now.  This includes
     saving the length of TEXT for efficiency, and initializing the index
     variable to 0. */
  if (!state)
    {
      list_index = 0;
      len = strlen (text);
    }

  /* Return the next name which partially matches from the command list. */
  while (name = commands[list_index].name)
    {
      list_index++;

      if (strncmp (name, text, len) == 0)
        return (dupstr(name));
    }

  /* If no names matched, then return NULL. */
  return ((char *)NULL);
}

/* **************************************************************** */
/*                                                                  */
/*                       FileMan Commands                           */
/*                                                                  */
/* **************************************************************** */

/* String to pass to system ().  This is for the LIST, VIEW and RENAME
   commands. */
static char syscom[1024];

/* List the file(s) named in arg. */
com_list (arg)
     char *arg;
{
  if (!arg)
    arg = "";

  sprintf (syscom, "ls -FClg %s", arg);
  return (system (syscom));
}

com_view (arg)
     char *arg;
{
  if (!valid_argument ("view", arg))
    return 1;

  sprintf (syscom, "more %s", arg);
  return (system (syscom));
}

com_rename (arg)
     char *arg;
{
  too_dangerous ("rename");
  return (1);
}

com_stat (arg)
     char *arg;
{
  struct stat finfo;

  if (!valid_argument ("stat", arg))
    return (1);

  if (stat (arg, &#38;finfo) == -1)
    {
      perror (arg);
      return (1);
    }

  printf ("Statistics for `%s':\n", arg);

  printf ("%s has %d link%s, and is %d byte%s in length.\n", arg,
          finfo.st_nlink,
          (finfo.st_nlink == 1) ? "" : "s",
          finfo.st_size,
          (finfo.st_size == 1) ? "" : "s");
  printf ("Inode Last Change at: %s", ctime (&#38;finfo.st_ctime));
  printf ("      Last access at: %s", ctime (&#38;finfo.st_atime));
  printf ("    Last modified at: %s", ctime (&#38;finfo.st_mtime));
  return (0);
}

com_delete (arg)
     char *arg;
{
  too_dangerous ("delete");
  return (1);
}

/* Print out help for ARG, or for all of the commands if ARG is
   not present. */
com_help (arg)
     char *arg;
{
  register int i;
  int printed = 0;

  for (i = 0; commands[i].name; i++)
    {
      if (!*arg || (strcmp (arg, commands[i].name) == 0))
        {
          printf ("%s\t\t%s.\n", commands[i].name, commands[i].doc);
          printed++;
        }
    }

  if (!printed)
    {
      printf ("No commands match `%s'.  Possibilties are:\n", arg);

      for (i = 0; commands[i].name; i++)
        {
          /* Print in six columns. */
          if (printed == 6)
            {
              printed = 0;
              printf ("\n");
            }

          printf ("%s\t", commands[i].name);
          printed++;
        }

      if (printed)
        printf ("\n");
    }
  return (0);
}

/* Change to the directory ARG. */
com_cd (arg)
     char *arg;
{
  if (chdir (arg) == -1)
    {
      perror (arg);
      return 1;
    }

  com_pwd ("");
  return (0);
}

/* Print out the current working directory. */
com_pwd (ignore)
     char *ignore;
{
  char dir[1024], *s;

  s = getwd (dir);
  if (s == 0)
    {
      printf ("Error getting pwd: %s\n", dir);
      return 1;
    }

  printf ("Current directory is %s\n", dir);
  return 0;
}

/* The user wishes to quit using this program.  Just set DONE non-zero. */
com_quit (arg)
     char *arg;
{
  done = 1;
  return (0);
}

/* Function which tells you that you can't do this. */
too_dangerous (caller)
     char *caller;
{
  fprintf (stderr,
           "%s: Too dangerous for me to distribute.  Write it yourself.\n",
           caller);
}

/* Return non-zero if ARG is a valid argument for CALLER, else print
   an error message and return zero. */
int
valid_argument (caller, arg)
     char *caller, *arg;
{
  if (!arg || !*arg)
    {
      fprintf (stderr, "%s: Argument required.\n", caller);
      return (0);
    }

  return (1);
}
</PRE>



<H1><A NAME="SEC46" HREF="readline.html#TOC46">Concept Index</A></H1>
<P>
Jump to:
<A HREF="#cindex_c">c</A>
-
<A HREF="#cindex_e">e</A>
-
<A HREF="#cindex_i">i</A>
-
<A HREF="#cindex_k">k</A>
-
<A HREF="#cindex_n">n</A>
-
<A HREF="#cindex_r">r</A>
-
<A HREF="#cindex_y">y</A>
<P>
<H2><A NAME="cindex_c">c</A></H2>
<DIR>
<LI><A HREF="readline.html#IDX3">command editing</A>
</DIR>
<H2><A NAME="cindex_e">e</A></H2>
<DIR>
<LI><A HREF="readline.html#IDX4">editing command lines</A>
</DIR>
<H2><A NAME="cindex_i">i</A></H2>
<DIR>
<LI><A HREF="readline.html#IDX8">initialization file, readline</A>
<LI><A HREF="readline.html#IDX1">interaction, readline</A>
</DIR>
<H2><A NAME="cindex_k">k</A></H2>
<DIR>
<LI><A HREF="readline.html#IDX7">kill ring</A>
<LI><A HREF="readline.html#IDX5">killing text</A>
</DIR>
<H2><A NAME="cindex_n">n</A></H2>
<DIR>
<LI><A HREF="readline.html#IDX2">notation, readline</A>
</DIR>
<H2><A NAME="cindex_r">r</A></H2>
<DIR>
<LI><A HREF="readline.html#IDX98">readline, function</A>
</DIR>
<H2><A NAME="cindex_y">y</A></H2>
<DIR>
<LI><A HREF="readline.html#IDX6">yanking text</A>
</DIR>

</P>


<H1><A NAME="SEC47" HREF="readline.html#TOC47">Function and Variable Index</A></H1>
<P>
Jump to:
<A HREF="#findex_a">a</A>
-
<A HREF="#findex_b">b</A>
-
<A HREF="#findex_c">c</A>
-
<A HREF="#findex_d">d</A>
-
<A HREF="#findex_e">e</A>
-
<A HREF="#findex_f">f</A>
-
<A HREF="#findex_h">h</A>
-
<A HREF="#findex_i">i</A>
-
<A HREF="#findex_k">k</A>
-
<A HREF="#findex_l">l</A>
-
<A HREF="#findex_m">m</A>
-
<A HREF="#findex_n">n</A>
-
<A HREF="#findex_o">o</A>
-
<A HREF="#findex_p">p</A>
-
<A HREF="#findex_q">q</A>
-
<A HREF="#findex_r">r</A>
-
<A HREF="#findex_s">s</A>
-
<A HREF="#findex_t">t</A>
-
<A HREF="#findex_u">u</A>
-
<A HREF="#findex_v">v</A>
-
<A HREF="#findex_y">y</A>
<P>
<H2><A NAME="findex_a">a</A></H2>
<DIR>
<LI><A HREF="readline.html#IDX83">abort (C-g)</A>
<LI><A HREF="readline.html#IDX34">accept-line (Newline, Return)</A>
<LI><A HREF="readline.html#IDX170">alphabetic</A>
</DIR>
<H2><A NAME="findex_b">b</A></H2>
<DIR>
<LI><A HREF="readline.html#IDX29">backward-char (C-b)</A>
<LI><A HREF="readline.html#IDX48">backward-delete-char (Rubout)</A>
<LI><A HREF="readline.html#IDX59">backward-kill-line (C-x Rubout)</A>
<LI><A HREF="readline.html#IDX63">backward-kill-word (M-DEL)</A>
<LI><A HREF="readline.html#IDX31">backward-word (M-b)</A>
<LI><A HREF="readline.html#IDX37">beginning-of-history (M-&#38;#60;)</A>
<LI><A HREF="readline.html#IDX26">beginning-of-line (C-a)</A>
<LI><A HREF="readline.html#IDX9">bell-style</A>
</DIR>
<H2><A NAME="findex_c">c</A></H2>
<DIR>
<LI><A HREF="readline.html#IDX81">call-last-kbd-macro (C-x e)</A>
<LI><A HREF="readline.html#IDX57">capitalize-word (M-c)</A>
<LI><A HREF="readline.html#IDX91">character-search (C-])</A>
<LI><A HREF="readline.html#IDX92">character-search-backward (M-C-])</A>
<LI><A HREF="readline.html#IDX32">clear-screen (C-l)</A>
<LI><A HREF="readline.html#IDX10">comment-begin</A>
<LI><A HREF="readline.html#IDX74">complete (TAB)</A>
<LI><A HREF="readline.html#IDX11">completion-query-items</A>
<LI><A HREF="readline.html#IDX197">completion_matches</A>
<LI><A HREF="readline.html#IDX12">convert-meta</A>
<LI><A HREF="readline.html#IDX68">copy-backward-word ()</A>
<LI><A HREF="readline.html#IDX69">copy-forward-word ()</A>
<LI><A HREF="readline.html#IDX67">copy-region-as-kill ()</A>
</DIR>
<H2><A NAME="findex_d">d</A></H2>
<DIR>
<LI><A HREF="readline.html#IDX47">delete-char (C-d)</A>
<LI><A HREF="readline.html#IDX78">delete-char-or-list ()</A>
<LI><A HREF="readline.html#IDX65">delete-horizontal-space ()</A>
<LI><A HREF="readline.html#IDX72">digit-argument (M-0, M-1, ... M--)</A>
<LI><A HREF="readline.html#IDX176">digit_p</A>
<LI><A HREF="readline.html#IDX179">digit_value</A>
<LI><A HREF="readline.html#IDX172">ding</A>
<LI><A HREF="readline.html#IDX13">disable-completion</A>
<LI><A HREF="readline.html#IDX84">do-uppercase-version (M-a, M-b, M-<VAR>x</VAR>, ...)</A>
<LI><A HREF="readline.html#IDX56">downcase-word (M-l)</A>
<LI><A HREF="readline.html#IDX94">dump-functions ()</A>
<LI><A HREF="readline.html#IDX96">dump-macros ()</A>
<LI><A HREF="readline.html#IDX95">dump-variables ()</A>
</DIR>
<H2><A NAME="findex_e">e</A></H2>
<DIR>
<LI><A HREF="readline.html#IDX14">editing-mode</A>
<LI><A HREF="readline.html#IDX15">enable-keypad</A>
<LI><A HREF="readline.html#IDX80">end-kbd-macro (C-x ))</A>
<LI><A HREF="readline.html#IDX38">end-of-history (M-&#38;#62;)</A>
<LI><A HREF="readline.html#IDX27">end-of-line (C-e)</A>
<LI><A HREF="readline.html#IDX90">exchange-point-and-mark (C-x C-x)</A>
<LI><A HREF="readline.html#IDX16">expand-tilde</A>
</DIR>
<H2><A NAME="findex_f">f</A></H2>
<DIR>
<LI><A HREF="readline.html#IDX198">filename_completion_function</A>
<LI><A HREF="readline.html#IDX49">forward-backward-delete-char ()</A>
<LI><A HREF="readline.html#IDX28">forward-char (C-f)</A>
<LI><A HREF="readline.html#IDX40">forward-search-history (C-s)</A>
<LI><A HREF="readline.html#IDX30">forward-word (M-f)</A>
<LI><A HREF="readline.html#IDX148">free_undo_list</A>
</DIR>
<H2><A NAME="findex_h">h</A></H2>
<DIR>
<LI><A HREF="readline.html#IDX44">history-search-backward ()</A>
<LI><A HREF="readline.html#IDX43">history-search-forward ()</A>
<LI><A HREF="readline.html#IDX17">horizontal-scroll-mode</A>
</DIR>
<H2><A NAME="findex_i">i</A></H2>
<DIR>
<LI><A HREF="readline.html#IDX18">input-meta</A>
<LI><A HREF="readline.html#IDX93">insert-comment (M-#)</A>
<LI><A HREF="readline.html#IDX76">insert-completions (M-*)</A>
<LI><A HREF="readline.html#IDX20">isearch-terminators</A>
</DIR>
<H2><A NAME="findex_k">k</A></H2>
<DIR>
<LI><A HREF="readline.html#IDX21">keymap</A>
<LI><A HREF="readline.html#IDX58">kill-line (C-k)</A>
<LI><A HREF="readline.html#IDX66">kill-region ()</A>
<LI><A HREF="readline.html#IDX61">kill-whole-line ()</A>
<LI><A HREF="readline.html#IDX62">kill-word (M-d)</A>
</DIR>
<H2><A NAME="findex_l">l</A></H2>
<DIR>
<LI><A HREF="readline.html#IDX175">lowercase_p</A>
</DIR>
<H2><A NAME="findex_m">m</A></H2>
<DIR>
<LI><A HREF="readline.html#IDX22">mark-modified-lines</A>
<LI><A HREF="readline.html#IDX77">menu-complete ()</A>
<LI><A HREF="readline.html#IDX19">meta-flag</A>
</DIR>
<H2><A NAME="findex_n">n</A></H2>
<DIR>
<LI><A HREF="readline.html#IDX36">next-history (C-n)</A>
<LI><A HREF="readline.html#IDX42">non-incremental-forward-search-history (M-n)</A>
<LI><A HREF="readline.html#IDX41">non-incremental-reverse-search-history (M-p)</A>
<LI><A HREF="readline.html#IDX171">numeric</A>
</DIR>
<H2><A NAME="findex_o">o</A></H2>
<DIR>
<LI><A HREF="readline.html#IDX23">output-meta</A>
</DIR>
<H2><A NAME="findex_p">p</A></H2>
<DIR>
<LI><A HREF="readline.html#IDX75">possible-completions (M-?)</A>
<LI><A HREF="readline.html#IDX85">prefix-meta (ESC)</A>
<LI><A HREF="readline.html#IDX35">previous-history (C-p)</A>
</DIR>
<H2><A NAME="findex_q">q</A></H2>
<DIR>
<LI><A HREF="readline.html#IDX50">quoted-insert (C-q, C-v)</A>
</DIR>
<H2><A NAME="findex_r">r</A></H2>
<DIR>
<LI><A HREF="readline.html#IDX82">re-read-init-file (C-x C-r)</A>
<LI><A HREF="readline.html#IDX97">readline</A>
<LI><A HREF="readline.html#IDX33">redraw-current-line ()</A>
<LI><A HREF="readline.html#IDX39">reverse-search-history (C-r)</A>
<LI><A HREF="readline.html#IDX87">revert-line (M-r)</A>
<LI><A HREF="readline.html#IDX120">rl_add_defun</A>
<LI><A HREF="readline.html#IDX147">rl_add_undo</A>
<LI><A HREF="readline.html#IDX107">rl_already_prompted</A>
<LI><A HREF="readline.html#IDX201">rl_attempted_completion_function</A>
<LI><A HREF="readline.html#IDX207">rl_basic_quote_characters</A>
<LI><A HREF="readline.html#IDX206">rl_basic_word_break_characters</A>
<LI><A HREF="readline.html#IDX145">rl_begin_undo_group</A>
<LI><A HREF="readline.html#IDX129">rl_bind_key</A>
<LI><A HREF="readline.html#IDX130">rl_bind_key_in_map</A>
<LI><A HREF="readline.html#IDX119">rl_binding_keymap</A>
<LI><A HREF="readline.html#IDX180">rl_callback_handler_install</A>
<LI><A HREF="readline.html#IDX182">rl_callback_handler_remove</A>
<LI><A HREF="readline.html#IDX181">rl_callback_read_char</A>
<LI><A HREF="readline.html#IDX183">rl_catch_signals</A>
<LI><A HREF="readline.html#IDX184">rl_catch_sigwinch</A>
<LI><A HREF="readline.html#IDX204">rl_char_is_quoted_p</A>
<LI><A HREF="readline.html#IDX185">rl_cleanup_after_signal</A>
<LI><A HREF="readline.html#IDX157">rl_clear_message</A>
<LI><A HREF="readline.html#IDX190">rl_clear_signals</A>
<LI><A HREF="readline.html#IDX191">rl_complete</A>, <A HREF="readline.html#IDX194">rl_complete</A>
<LI><A HREF="readline.html#IDX193">rl_complete_internal</A>
<LI><A HREF="readline.html#IDX209">rl_completer_quote_characters</A>
<LI><A HREF="readline.html#IDX208">rl_completer_word_break_characters</A>
<LI><A HREF="readline.html#IDX212">rl_completion_append_character</A>
<LI><A HREF="readline.html#IDX219">rl_completion_display_matches_hook</A>
<LI><A HREF="readline.html#IDX192">rl_completion_entry_function</A>, <A HREF="readline.html#IDX200">rl_completion_entry_function</A>
<LI><A HREF="readline.html#IDX205">rl_completion_query_items</A>
<LI><A HREF="readline.html#IDX122">rl_copy_keymap</A>
<LI><A HREF="readline.html#IDX162">rl_copy_text</A>
<LI><A HREF="readline.html#IDX161">rl_delete_text</A>
<LI><A HREF="readline.html#IDX218">rl_directory_completion_hook</A>
<LI><A HREF="readline.html#IDX124">rl_discard_keymap</A>
<LI><A HREF="readline.html#IDX173">rl_display_match_list</A>
<LI><A HREF="readline.html#IDX149">rl_do_undo</A>
<LI><A HREF="readline.html#IDX103">rl_done</A>
<LI><A HREF="readline.html#IDX101">rl_end</A>
<LI><A HREF="readline.html#IDX146">rl_end_undo_group</A>
<LI><A HREF="readline.html#IDX105">rl_erase_empty_line</A>
<LI><A HREF="readline.html#IDX115">rl_event_hook</A>
<LI><A HREF="readline.html#IDX118">rl_executing_keymap</A>
<LI><A HREF="readline.html#IDX167">rl_extend_line_buffer</A>
<LI><A HREF="readline.html#IDX214">rl_filename_completion_desired</A>
<LI><A HREF="readline.html#IDX203">rl_filename_dequoting_function</A>
<LI><A HREF="readline.html#IDX210">rl_filename_quote_characters</A>
<LI><A HREF="readline.html#IDX215">rl_filename_quoting_desired</A>
<LI><A HREF="readline.html#IDX202">rl_filename_quoting_function</A>
<LI><A HREF="readline.html#IDX152">rl_forced_update_display</A>
<LI><A HREF="readline.html#IDX186">rl_free_line_state</A>
<LI><A HREF="readline.html#IDX142">rl_function_dumper</A>
<LI><A HREF="readline.html#IDX139">rl_function_of_keyseq</A>
<LI><A HREF="readline.html#IDX144">rl_funmap_names</A>
<LI><A HREF="readline.html#IDX135">rl_generic_bind</A>
<LI><A HREF="readline.html#IDX125">rl_get_keymap</A>
<LI><A HREF="readline.html#IDX127">rl_get_keymap_by_name</A>
<LI><A HREF="readline.html#IDX128">rl_get_keymap_name</A>
<LI><A HREF="readline.html#IDX165">rl_getc</A>
<LI><A HREF="readline.html#IDX116">rl_getc_function</A>
<LI><A HREF="readline.html#IDX213">rl_ignore_completion_duplicates</A>
<LI><A HREF="readline.html#IDX217">rl_ignore_some_completions_function</A>
<LI><A HREF="readline.html#IDX216">rl_inhibit_completion</A>
<LI><A HREF="readline.html#IDX168">rl_initialize</A>
<LI><A HREF="readline.html#IDX196">rl_insert_completions</A>
<LI><A HREF="readline.html#IDX160">rl_insert_text</A>
<LI><A HREF="readline.html#IDX111">rl_instream</A>
<LI><A HREF="readline.html#IDX140">rl_invoking_keyseqs</A>
<LI><A HREF="readline.html#IDX141">rl_invoking_keyseqs_in_map</A>
<LI><A HREF="readline.html#IDX163">rl_kill_text</A>
<LI><A HREF="readline.html#IDX108">rl_library_version</A>
<LI><A HREF="readline.html#IDX99">rl_line_buffer</A>
<LI><A HREF="readline.html#IDX143">rl_list_funmap_names</A>
<LI><A HREF="readline.html#IDX121">rl_make_bare_keymap</A>
<LI><A HREF="readline.html#IDX123">rl_make_keymap</A>
<LI><A HREF="readline.html#IDX102">rl_mark</A>
<LI><A HREF="readline.html#IDX156">rl_message</A>
<LI><A HREF="readline.html#IDX150">rl_modifying</A>
<LI><A HREF="readline.html#IDX138">rl_named_function</A>
<LI><A HREF="readline.html#IDX153">rl_on_new_line</A>
<LI><A HREF="readline.html#IDX154">rl_on_new_line_with_prompt</A>
<LI><A HREF="readline.html#IDX112">rl_outstream</A>
<LI><A HREF="readline.html#IDX136">rl_parse_and_bind</A>
<LI><A HREF="readline.html#IDX104">rl_pending_input</A>
<LI><A HREF="readline.html#IDX100">rl_point</A>
<LI><A HREF="readline.html#IDX195">rl_possible_completions</A>
<LI><A HREF="readline.html#IDX114">rl_pre_input_hook</A>
<LI><A HREF="readline.html#IDX106">rl_prompt</A>
<LI><A HREF="readline.html#IDX137">rl_read_init_file</A>
<LI><A HREF="readline.html#IDX164">rl_read_key</A>
<LI><A HREF="readline.html#IDX110">rl_readline_name</A>
<LI><A HREF="readline.html#IDX151">rl_redisplay</A>
<LI><A HREF="readline.html#IDX117">rl_redisplay_function</A>
<LI><A HREF="readline.html#IDX187">rl_reset_after_signal</A>
<LI><A HREF="readline.html#IDX155">rl_reset_line_state</A>
<LI><A HREF="readline.html#IDX169">rl_reset_terminal</A>
<LI><A HREF="readline.html#IDX188">rl_resize_terminal</A>
<LI><A HREF="readline.html#IDX159">rl_restore_prompt</A>
<LI><A HREF="readline.html#IDX158">rl_save_prompt</A>
<LI><A HREF="readline.html#IDX126">rl_set_keymap</A>
<LI><A HREF="readline.html#IDX189">rl_set_signals</A>
<LI><A HREF="readline.html#IDX211">rl_special_prefixes</A>
<LI><A HREF="readline.html#IDX113">rl_startup_hook</A>
<LI><A HREF="readline.html#IDX166">rl_stuff_char</A>
<LI><A HREF="readline.html#IDX109">rl_terminal_name</A>
<LI><A HREF="readline.html#IDX134">rl_unbind_command_in_map</A>
<LI><A HREF="readline.html#IDX133">rl_unbind_function_in_map</A>
<LI><A HREF="readline.html#IDX131">rl_unbind_key</A>
<LI><A HREF="readline.html#IDX132">rl_unbind_key_in_map</A>
</DIR>
<H2><A NAME="findex_s">s</A></H2>
<DIR>
<LI><A HREF="readline.html#IDX52">self-insert (a, b, A, 1, !, ...)</A>
<LI><A HREF="readline.html#IDX89">set-mark (C-@)</A>
<LI><A HREF="readline.html#IDX24">show-all-if-ambiguous</A>
<LI><A HREF="readline.html#IDX79">start-kbd-macro (C-x ()</A>
</DIR>
<H2><A NAME="findex_t">t</A></H2>
<DIR>
<LI><A HREF="readline.html#IDX51">tab-insert (M-TAB)</A>
<LI><A HREF="readline.html#IDX88">tilde-expand (M-~)</A>
<LI><A HREF="readline.html#IDX178">to_lower</A>
<LI><A HREF="readline.html#IDX177">to_upper</A>
<LI><A HREF="readline.html#IDX53">transpose-chars (C-t)</A>
<LI><A HREF="readline.html#IDX54">transpose-words (M-t)</A>
</DIR>
<H2><A NAME="findex_u">u</A></H2>
<DIR>
<LI><A HREF="readline.html#IDX86">undo (C-_, C-x C-u)</A>
<LI><A HREF="readline.html#IDX73">universal-argument ()</A>
<LI><A HREF="readline.html#IDX60">unix-line-discard (C-u)</A>
<LI><A HREF="readline.html#IDX64">unix-word-rubout (C-w)</A>
<LI><A HREF="readline.html#IDX55">upcase-word (M-u)</A>
<LI><A HREF="readline.html#IDX174">uppercase_p</A>
<LI><A HREF="readline.html#IDX199">username_completion_function</A>
</DIR>
<H2><A NAME="findex_v">v</A></H2>
<DIR>
<LI><A HREF="readline.html#IDX25">visible-stats</A>
</DIR>
<H2><A NAME="findex_y">y</A></H2>
<DIR>
<LI><A HREF="readline.html#IDX70">yank (C-y)</A>
<LI><A HREF="readline.html#IDX46">yank-last-arg (M-., M-_)</A>
<LI><A HREF="readline.html#IDX45">yank-nth-arg (M-C-y)</A>
<LI><A HREF="readline.html#IDX71">yank-pop (M-y)</A>
</DIR>

</P>
<P><HR><P>
This document was generated on 1 March 2000 using the
<A HREF="http://wwwinfo.cern.ch/dis/texi2html/">texi2html</A>
translator version 1.52.</P>
</BODY>
</HTML>
generated by cgit v1.1 at 2024-11-11 12:56:11 +0000