/usr/share/doc/vim/html/options.html is in vim-doc 2:8.0.1453-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652 8653 8654 8655 8656 8657 8658 8659 8660 8661 8662 8663 8664 8665 8666 8667 8668 8669 8670 8671 8672 8673 8674 8675 8676 8677 8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742 8743 8744 8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755 8756 8757 8758 8759 8760 8761 8762 8763 8764 8765 8766 8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780 8781 8782 8783 8784 8785 8786 8787 8788 8789 8790 8791 8792 8793 8794 8795 8796 8797 8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 8812 8813 8814 8815 8816 8817 8818 8819 8820 8821 8822 8823 8824 8825 8826 8827 8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844 8845 8846 8847 8848 8849 8850 8851 8852 8853 8854 8855 8856 8857 8858 8859 8860 8861 8862 8863 8864 8865 8866 8867 8868 8869 8870 8871 8872 8873 8874 8875 8876 8877 8878 8879 8880 8881 8882 8883 8884 8885 8886 8887 8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898 8899 8900 8901 8902 8903 8904 8905 8906 8907 8908 8909 8910 8911 8912 8913 8914 8915 8916 8917 8918 8919 8920 8921 8922 8923 8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 8964 8965 8966 8967 8968 8969 8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992 8993 8994 8995 8996 8997 8998 8999 9000 9001 9002 9003 9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021 9022 9023 9024 9025 9026 9027 9028 9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042 9043 9044 9045 9046 9047 9048 9049 9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074 9075 9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088 9089 9090 9091 9092 9093 9094 9095 9096 9097 9098 9099 9100 9101 9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121 9122 9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326 9327 9328 9329 9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353 9354 9355 9356 9357 9358 9359 9360 9361 9362 9363 9364 9365 9366 9367 9368 9369 9370 9371 9372 9373 9374 9375 9376 9377 9378 9379 9380 9381 9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438 9439 9440 9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 9464 9465 9466 9467 9468 9469 9470 9471 9472 9473 9474 9475 9476 9477 9478 9479 9480 9481 9482 9483 9484 9485 9486 9487 9488 9489 9490 9491 9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502 9503 9504 9505 9506 9507 9508 9509 9510 9511 9512 9513 9514 9515 9516 9517 9518 9519 9520 9521 9522 9523 9524 9525 9526 9527 9528 9529 9530 9531 9532 9533 9534 9535 9536 9537 9538 9539 9540 9541 9542 9543 9544 9545 9546 9547 9548 9549 9550 9551 9552 9553 9554 9555 9556 9557 9558 9559 9560 9561 9562 9563 9564 9565 9566 9567 9568 9569 9570 9571 9572 9573 9574 9575 9576 9577 9578 9579 9580 9581 9582 9583 9584 9585 9586 9587 9588 9589 9590 9591 9592 9593 9594 9595 9596 9597 9598 9599 9600 9601 9602 9603 9604 9605 9606 9607 9608 9609 9610 9611 9612 9613 9614 9615 9616 9617 9618 9619 9620 9621 9622 9623 9624 9625 9626 9627 9628 9629 9630 9631 9632 9633 9634 9635 9636 9637 9638 9639 9640 9641 9642 9643 9644 9645 9646 9647 9648 9649 9650 9651 9652 9653 9654 9655 9656 9657 9658 9659 9660 9661 9662 9663 9664 9665 9666 9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678 9679 9680 9681 9682 9683 9684 9685 9686 9687 9688 9689 9690 9691 9692 9693 9694 | <HTML>
<HEAD>
<META HTTP-EQUIV="Content-type" content="text/html; charset=ISO-8859-1">
<TITLE>Vim documentation: options</TITLE>
</HEAD>
<BODY BGCOLOR="#ffffff">
<H1>Vim documentation: options</H1>
<A NAME="top"></A>
<A HREF="index.html">main help file</A>
<HR>
<PRE>
*<A NAME="options.txt"></A><B>options.txt</B>* For Vim version 8.0. Last change: 2017 Dec 21
VIM REFERENCE MANUAL by <A HREF="intro.html#Bram">Bram</A> <A HREF="intro.html#Moolenaar">Moolenaar</A>
Options *<A NAME="options"></A><B>options</B>*
1. Setting <A HREF="#options">options</A> |<A HREF="#set-option">set-option</A>|
2. Automatically setting <A HREF="#options">options</A> |<A HREF="#auto-setting">auto-setting</A>|
3. Options summary |<A HREF="#option-summary">option-summary</A>|
For an overview of <A HREF="#options">options</A> see <A HREF="quickref.html#quickref.txt">quickref.txt</A> |<A HREF="quickref.html#option-list">option-list</A>|.
Vim has a number of internal <A HREF="eval.html#variables">variables</A> and switches which can be set to
achieve special effects. These <A HREF="#options">options</A> come in three forms:
<A HREF="#boolean">boolean</A> can only be on or off *<A NAME="boolean"></A><B>boolean</B>* *<A NAME="toggle"></A><B>toggle</B>*
number has a numeric value
<A HREF="eval.html#string">string</A> has a <A HREF="eval.html#string">string</A> value
==============================================================================
1. Setting <A HREF="#options">options</A> *<A NAME="set-option"></A><B>set-option</B>* *<A NAME="E764"></A><B>E764</B>*
*<A NAME=":se"></A><B>:se</B>* *<A NAME=":set"></A><B>:set</B>*
:se[t] Show all <A HREF="#options">options</A> that differ from their default value.
:se[t] all Show all but <A HREF="terminal.html#terminal">terminal</A> <A HREF="#options">options</A>.
:se[t] <A HREF="term.html#termcap">termcap</A> Show all <A HREF="terminal.html#terminal">terminal</A> <A HREF="#options">options</A>. Note that in the <A HREF="gui.html#GUI">GUI</A> the
key codes are not shown, because they are generated
internally and can't be changed. Changing the <A HREF="terminal.html#terminal">terminal</A>
codes in the <A HREF="gui.html#GUI">GUI</A> is not useful either...
*<A NAME="E518"></A><B>E518</B>* *<A NAME="E519"></A><B>E519</B>*
:se[t] {option}? Show value of {option}.
:se[t] {option} Toggle option: set, switch <A HREF="motion.html#it">it</A> on.
<A HREF="eval.html#Number">Number</A> option: show value.
<A HREF="eval.html#String">String</A> option: show value.
:se[t] no{option} Toggle option: Reset, switch <A HREF="motion.html#it">it</A> off.
*<A NAME=":set-!"></A><B>:set-!</B>* *<A NAME=":set-inv"></A><B>:set-inv</B>*
:se[t] {option}! or
:se[t] inv{option} Toggle option: Invert value. {not in Vi}
*<A NAME=":set-default"></A><B>:set-default</B>* *<A NAME=":set-&"></A><B>:set-&</B>* *<A NAME=":set-&vi"></A><B>:set-&vi</B>* *<A NAME=":set-&vim"></A><B>:set-&vim</B>*
:se[t] {option}& Reset option to its default value. May depend on the
current value of <A HREF="#'compatible'">'compatible'</A>. {not in Vi}
:se[t] {option}&vi Reset option to its <A HREF="intro.html#Vi">Vi</A> default value. {not in Vi}
:se[t] {option}&vim Reset option to its Vim default value. {not in Vi}
:se[t] all& Set all <A HREF="#options">options</A> to their default value. The values of
these <A HREF="#options">options</A> are not changed:
all <A HREF="terminal.html#terminal">terminal</A> <A HREF="#options">options</A>, starting with t_
<A HREF="#'columns'">'columns'</A>
<A HREF="#'cryptmethod'">'cryptmethod'</A>
<A HREF="#'encoding'">'encoding'</A>
<A HREF="#'key'">'key'</A>
<A HREF="#'lines'">'lines'</A>
<A HREF="#'term'">'term'</A>
<A HREF="#'ttymouse'">'ttymouse'</A>
<A HREF="#'ttytype'">'ttytype'</A>
Warning: This may have a lot of side effects.
{not in Vi}
*<A NAME=":set-args"></A><B>:set-args</B>* *<A NAME="E487"></A><B>E487</B>* *<A NAME="E521"></A><B>E521</B>*
:se[t] {option}={value} or
:se[t] {option}:{value}
Set <A HREF="eval.html#string">string</A> or number option to {value}.
For numeric <A HREF="#options">options</A> the value can be given in decimal,
hex (preceded with 0x) or <A HREF="eval.html#octal">octal</A> (preceded with '0').
The old value can be inserted by typing <A HREF="#'wildchar'">'wildchar'</A> (by
default this is a <A HREF="motion.html#<Tab>"><Tab></A> or <A HREF="scroll.html#CTRL-E">CTRL-E</A> if <A HREF="#'compatible'">'compatible'</A> is
set). See |<A HREF="cmdline.html#cmdline-completion">cmdline-completion</A>|.
White space between {option} and '<A HREF="change.html#=">=</A>' is allowed and
will be ignored. White space between '<A HREF="change.html#=">=</A>' and {value}
is not allowed.
See |<A HREF="#option-backslash">option-backslash</A>| for using white space and
backslashes in {value}.
:se[t] {option}+={value} *<A NAME=":set+="></A><B>:set+=</B>*
Add the {value} to a number option, or append the
{value} to a <A HREF="eval.html#string">string</A> option. When the option is a
comma separated <A HREF="eval.html#list">list</A>, a comma is added, unless the
value was empty.
If the option is a <A HREF="eval.html#list">list</A> of flags, superfluous flags
are removed. When adding a flag that was already
present the option value doesn't change.
Also see |<A HREF="#:set-args">:set-args</A>| above.
{not in Vi}
:se[t] {option}^={value} *<A NAME=":set^="></A><B>:set^=</B>*
Multiply the {value} to a number option, or prepend
the {value} to a <A HREF="eval.html#string">string</A> option. When the option is a
comma separated <A HREF="eval.html#list">list</A>, a comma is added, unless the
value was empty.
Also see |<A HREF="#:set-args">:set-args</A>| above.
{not in Vi}
:se[t] {option}-={value} *<A NAME=":set-="></A><B>:set-=</B>*
Subtract the {value} from a number option, or remove
the {value} from a <A HREF="eval.html#string">string</A> option, if <A HREF="motion.html#it">it</A> is there.
If the {value} is not found in a <A HREF="eval.html#string">string</A> option, there
is no error or warning. When the option is a comma
separated <A HREF="eval.html#list">list</A>, a comma is deleted, unless the option
becomes empty.
When the option is a <A HREF="eval.html#list">list</A> of flags, {value} must be
exactly <A HREF="motion.html#as">as</A> they appear in the option. Remove flags
one by one to avoid problems.
Also see |<A HREF="#:set-args">:set-args</A>| above.
{not in Vi}
The {option} arguments to "<A HREF="#:set">:set</A>" may be repeated. For example:
<B> :set ai nosi sw=3 ts=3</B>
If you make an error in one of the arguments, an error message will be given
and the following arguments will be ignored.
*<A NAME=":set-verbose"></A><B>:set-verbose</B>*
When <A HREF="#'verbose'">'verbose'</A> is non-zero, displaying an option value will also tell where <A HREF="motion.html#it">it</A>
was last set. Example:
<B> :verbose set shiftwidth cindent?</B>
<B><FONT COLOR="PURPLE"> shiftwidth=4 </FONT></B>
<B><FONT COLOR="PURPLE"> Last set from modeline </FONT></B>
<B><FONT COLOR="PURPLE"> cindent </FONT></B>
<B><FONT COLOR="PURPLE"> Last set from /usr/local/share/vim/vim60/ftplugin/c.vim </FONT></B>
This is only done when specific option values are requested, not for "<A HREF="various.html#:verbose">:verbose</A>
set all" or "<A HREF="various.html#:verbose">:verbose</A> set" without an argument.
When the option was set by hand there is no "Last set" message.
When the option was set while executing a function, user command or
<A HREF="autocmd.html#autocommand">autocommand</A>, the <A HREF="usr_41.html#script">script</A> in which <A HREF="motion.html#it">it</A> was defined is reported.
Note that an option may also have been set <A HREF="motion.html#as">as</A> a side effect of setting
<A HREF="#'compatible'">'compatible'</A>.
A few special texts:
<B><FONT COLOR="PURPLE"> Last set from modeline </FONT></B>
Option was set in a |<A HREF="#modeline">modeline</A>|.
<B><FONT COLOR="PURPLE"> Last set from --cmd argument </FONT></B>
Option was set with command line argument |<A HREF="starting.html#--cmd">--cmd</A>| or +.
<B><FONT COLOR="PURPLE"> Last set from -c argument </FONT></B>
Option was set with command line argument |<A HREF="starting.html#-c">-c</A>|, +, |<A HREF="starting.html#-S">-S</A>| or
|<A HREF="starting.html#-q">-q</A>|.
<B><FONT COLOR="PURPLE"> Last set from environment variable </FONT></B>
Option was set from an environment variable, $VIMINIT,
$GVIMINIT or $EXINIT.
<B><FONT COLOR="PURPLE"> Last set from error handler </FONT></B>
Option was cleared when evaluating <A HREF="motion.html#it">it</A> resulted in an error.
{not available when compiled without the |<A HREF="various.html#+eval">+eval</A>| feature}
*<A NAME=":set-termcap"></A><B>:set-termcap</B>* *<A NAME="E522"></A><B>E522</B>*
For {option} the form "t_xx" may be used to set a <A HREF="terminal.html#terminal">terminal</A> option. This will
override the value from the <A HREF="term.html#termcap">termcap</A>. You can then use <A HREF="motion.html#it">it</A> in a <A HREF="map.html#mapping">mapping</A>. If
the "xx" part contains special characters, use the <t_xx> form:
<B> :set <t_#4>=^[Ot</B>
This can also be used to translate a special code for a normal key. For
example, if Alt-b produces <Esc>b, use this:
<B> :set <M-b>=^[b</B>
(the ^[ is a real <A HREF="intro.html#<Esc>"><Esc></A> here, use <A HREF="visual.html#CTRL-V">CTRL-V</A> <A HREF="intro.html#<Esc>"><Esc></A> to enter <A HREF="motion.html#it">it</A>)
The advantage over a <A HREF="map.html#mapping">mapping</A> is that <A HREF="motion.html#it">it</A> works in all situations.
You can define any key codes, e.g.:
<B> :set t_xy=^[foo;</B>
There is no warning for using a name that isn't recognized. You can map these
codes <A HREF="motion.html#as">as</A> you like:
<B> :map <t_xy> something</B>
*<A NAME="E846"></A><B>E846</B>*
When a key code is not set, it's like <A HREF="motion.html#it">it</A> does not exist. Trying to get its
value will result in an error:
<B> :set t_kb=</B>
<B> :set t_kb</B>
<B> E846: Key code not set: t_kb</B>
The t_xx <A HREF="#options">options</A> cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
The listing from "<A HREF="#:set">:set</A>" looks different from <A HREF="intro.html#Vi">Vi</A>. Long <A HREF="eval.html#string">string</A> <A HREF="#options">options</A> are put
at the end of the <A HREF="eval.html#list">list</A>. The number of <A HREF="#options">options</A> is quite large. The output of
"set all" probably does not fit on the screen, causing Vim to give the
|<A HREF="message.html#more-prompt">more-prompt</A>|.
*<A NAME="option-backslash"></A><B>option-backslash</B>*
To include white space in a <A HREF="eval.html#string">string</A> option value <A HREF="motion.html#it">it</A> has to be preceded with a
<A HREF="intro.html#backslash">backslash</A>. To include a <A HREF="intro.html#backslash">backslash</A> you have to use two. Effectively this
means that the number of backslashes in an option value is halved (rounded
down).
A few examples:
<B> :set tags=tags\ /usr/tags results in "tags /usr/tags"</B>
<B> :set tags=tags\\,file results in "tags\,file"</B>
<B> :set tags=tags\\\ file results in "tags\ file"</B>
The "|" character separates a "<A HREF="#:set">:set</A>" command from a following command. To
include the "|" in the option value, use "\|" instead. This example sets the
<A HREF="#'titlestring'">'titlestring'</A> option to "hi|there":
<B> :set titlestring=hi\|there</B>
This sets the <A HREF="#'titlestring'">'titlestring'</A> option to "hi" and <A HREF="#'iconstring'">'iconstring'</A> to "there":
<B> :set titlestring=hi|set iconstring=there</B>
Similarly, the double <A HREF="change.html#quote">quote</A> character starts a comment. To include the '"'' in
the option value, use '\"' instead. This example sets the <A HREF="#'titlestring'">'titlestring'</A>
option to 'hi "there"':
<B> :set titlestring=hi\ \"there\"</B>
For <A HREF="os_msdos.html#MS-DOS">MS-DOS</A> and WIN32 backslashes in file names are mostly not removed. More
precise: For <A HREF="#options">options</A> that expect a file name (those where environment
<A HREF="eval.html#variables">variables</A> are expanded) a <A HREF="intro.html#backslash">backslash</A> before a normal file name character is not
removed. But a <A HREF="intro.html#backslash">backslash</A> before a special character (space, <A HREF="intro.html#backslash">backslash</A>, comma,
etc.) is used like explained above.
There is one special situation, when the value starts with "\\":
<B> :set dir=\\machine\path results in "\\machine\path"</B>
<B> :set dir=\\\\machine\\path results in "\\machine\path"</B>
<B> :set dir=\\path\\file results in "\\path\file" (wrong!)</B>
For the first one the start is kept, but for the second one the backslashes
are halved. This makes sure <A HREF="motion.html#it">it</A> works both when you expect backslashes to be
halved and when you expect the backslashes to be kept. The third gives a
result which is probably not what you want. Avoid <A HREF="motion.html#it">it</A>.
*<A NAME="add-option-flags"></A><B>add-option-flags</B>* *<A NAME="remove-option-flags"></A><B>remove-option-flags</B>*
*<A NAME="E539"></A><B>E539</B>* *<A NAME="E550"></A><B>E550</B>* *<A NAME="E551"></A><B>E551</B>* *<A NAME="E552"></A><B>E552</B>*
Some <A HREF="#options">options</A> are a <A HREF="eval.html#list">list</A> of flags. When you want to add a flag to such an
option, without <A HREF="change.html#changing">changing</A> the existing ones, you can <A HREF="diff.html#do">do</A> <A HREF="motion.html#it">it</A> like this:
<B> :set guioptions+=a</B>
Remove a flag from an option like this:
<B> :set guioptions-=a</B>
This removes the '<A HREF="insert.html#a">a</A>' flag from <A HREF="#'guioptions'">'guioptions'</A>.
Note that you should add or remove one flag at a time. If <A HREF="#'guioptions'">'guioptions'</A> has
the value "<A HREF="motion.html#ab">ab</A>", using "set guioptions-=ba" won't work, because the <A HREF="eval.html#string">string</A> "ba"
doesn't appear.
*<A NAME=":set_env"></A><B>:set_env</B>* *<A NAME="expand-env"></A><B>expand-env</B>* *<A NAME="expand-environment-var"></A><B>expand-environment-var</B>*
Environment <A HREF="eval.html#variables">variables</A> in specific <A HREF="eval.html#string">string</A> <A HREF="#options">options</A> will be expanded. If the
environment variable exists the '<A HREF="motion.html#$">$</A>' and the following environment variable
name is replaced with its value. If <A HREF="motion.html#it">it</A> does not exist the '<A HREF="motion.html#$">$</A>' and the name
are not modified. Any non-id character (not a <A HREF="print.html#letter">letter</A>, digit or '<A HREF="motion.html#_">_</A>') may
follow the environment variable name. That character and what follows is
appended to the value of the environment variable. Examples:
<B> :set term=$TERM.new</B>
<B> :set path=/usr/$INCLUDE,$HOME/include,.</B>
When adding or removing a <A HREF="eval.html#string">string</A> from an option with "<A HREF="#:set">:set</A> opt-=val" or "<A HREF="#:set">:set</A>
opt+=val" the expansion is done before the adding or removing.
Handling of local <A HREF="#options">options</A> *<A NAME="local-options"></A><B>local-options</B>*
Some of the <A HREF="#options">options</A> only apply to a <A HREF="windows.html#window">window</A> or buffer. Each <A HREF="windows.html#window">window</A> or buffer
has its own copy of this option, thus each can have its own value. This
allows you to set <A HREF="#'list'">'list'</A> in one <A HREF="windows.html#window">window</A> but not in another. And set
<A HREF="#'shiftwidth'">'shiftwidth'</A> to 3 in one buffer and 4 in another.
The following explains what happens to these local <A HREF="#options">options</A> in specific
situations. You don't really need to know all of this, since Vim mostly uses
the option values you would expect. Unfortunately, doing what the user
expects is a bit complicated...
When splitting a <A HREF="windows.html#window">window</A>, the local <A HREF="#options">options</A> are copied to the new <A HREF="windows.html#window">window</A>. Thus
right after the split the contents of the two <A HREF="windows.html#windows">windows</A> look the same.
When editing a new buffer, its local option values must be initialized. Since
the local <A HREF="#options">options</A> of the current buffer might be specifically for that buffer,
these are not used. Instead, for each buffer-local option there also is a
global value, which is used for new <A HREF="windows.html#buffers">buffers</A>. With "<A HREF="#:set">:set</A>" both the local and
global value is changed. With "setlocal" only the local value is changed,
thus this value is not used when editing a new buffer.
When editing a buffer that has been edited before, the <A HREF="#options">options</A> from the <A HREF="windows.html#window">window</A>
that was last closed are used again. If this buffer has been edited in this
<A HREF="windows.html#window">window</A>, the values from back then are used. Otherwise the values from the
last closed <A HREF="windows.html#window">window</A> where the buffer was edited last are used.
It's possible to set a local <A HREF="windows.html#window">window</A> option specifically for a type of buffer.
When you edit another buffer in the same <A HREF="windows.html#window">window</A>, you don't want to keep
using these local <A HREF="windows.html#window">window</A> <A HREF="#options">options</A>. Therefore Vim keeps a global value of the
local <A HREF="windows.html#window">window</A> <A HREF="#options">options</A>, which is used when editing another buffer. Each <A HREF="windows.html#window">window</A>
has its own copy of these values. Thus these are local to the <A HREF="windows.html#window">window</A>, but
global to all <A HREF="windows.html#buffers">buffers</A> in the <A HREF="windows.html#window">window</A>. With this you can <A HREF="diff.html#do">do</A>:
<B> :e one</B>
<B> :set list</B>
<B> :e two</B>
Now the <A HREF="#'list'">'list'</A> option will also be set in "two", since with the "<A HREF="#:set">:set</A> <A HREF="#'list'">list</A>"
command you have also set the global value.
<B> :set nolist</B>
<B> :e one</B>
<B> :setlocal list</B>
<B> :e two</B>
Now the <A HREF="#'list'">'list'</A> option is not set, because "<A HREF="#:set">:set</A> <A HREF="#'nolist'">nolist</A>" resets the global
value, "<A HREF="#:setlocal">:setlocal</A> list" only changes the local value and "<A HREF="editing.html#:e">:e</A> two" gets the
global value. Note that if you <A HREF="diff.html#do">do</A> this next:
<B> :e one</B>
You will get back the <A HREF="#'list'">'list'</A> value <A HREF="motion.html#as">as</A> <A HREF="motion.html#it">it</A> was the last time you edited "one".
The <A HREF="#options">options</A> local to a <A HREF="windows.html#window">window</A> are remembered for each buffer. This also
happens when the buffer is not loaded, but they are lost when the buffer is
wiped out |<A HREF="windows.html#:bwipe">:bwipe</A>|.
*<A NAME=":setl"></A><B>:setl</B>* *<A NAME=":setlocal"></A><B>:setlocal</B>*
:setl[ocal] <A HREF="eval.html#...">...</A> Like "<A HREF="#:set">:set</A>" but set only the value local to the
current buffer or <A HREF="windows.html#window">window</A>. Not all <A HREF="#options">options</A> have a
local value. If the option does not have a local
value the global value is set.
With the "all" argument: display local values for all
local <A HREF="#options">options</A>.
Without argument: Display local values for all local
<A HREF="#options">options</A> which are different from the default.
When displaying a specific local option, show the
local value. For a global/local <A HREF="#boolean">boolean</A> option, when
the global value is being used, "<A HREF="starting.html#--">--</A>" is displayed
before the option name.
For a global option the global value is
shown (but that might change in the future).
{not in Vi}
:setl[ocal] {option}< Set the local value of {option} to its global value by
<A HREF="uganda.html#copying">copying</A> the value.
{not in Vi}
:se[t] {option}< For |<A HREF="#global-local">global-local</A>| <A HREF="#options">options</A>: Remove the local value of
{option}, so that the global value will be used.
{not in Vi}
*<A NAME=":setg"></A><B>:setg</B>* *<A NAME=":setglobal"></A><B>:setglobal</B>*
:setg[lobal] <A HREF="eval.html#...">...</A> Like "<A HREF="#:set">:set</A>" but set only the global value for a local
option without <A HREF="change.html#changing">changing</A> the local value.
When displaying an option, the global value is shown.
With the "all" argument: display global values for all
local <A HREF="#options">options</A>.
Without argument: display global values for all local
<A HREF="#options">options</A> which are different from the default.
{not in Vi}
For buffer-local and window-local <A HREF="#options">options</A>:
<B><FONT COLOR="PURPLE"> Command global value local value </FONT></B>
<A HREF="#:set">:set</A> <A HREF="intro.html#'option'">option</A>=value set set
<A HREF="#:setlocal">:setlocal</A> option=value - set
<A HREF="#:setglobal">:setglobal</A> option=value set -
<A HREF="#:set">:set</A> option? - display
<A HREF="#:setlocal">:setlocal</A> option? - display
<A HREF="#:setglobal">:setglobal</A> option? display -
Global <A HREF="#options">options</A> with a local value *<A NAME="global-local"></A><B>global-local</B>*
Options are global when you mostly use one value for all <A HREF="windows.html#buffers">buffers</A> and <A HREF="windows.html#windows">windows</A>.
For some global <A HREF="#options">options</A> it's useful to sometimes have a different local value.
You can set the local value with "<A HREF="#:setlocal">:setlocal</A>". That buffer or <A HREF="windows.html#window">window</A> will then
use the local value, while other <A HREF="windows.html#buffers">buffers</A> and <A HREF="windows.html#windows">windows</A> continue using the global
value.
For example, you have two <A HREF="windows.html#windows">windows</A>, both on C source code. They use the global
<A HREF="#'makeprg'">'makeprg'</A> option. If you <A HREF="diff.html#do">do</A> this in one of the two <A HREF="windows.html#windows">windows</A>:
<B> :set makeprg=gmake</B>
then the other <A HREF="windows.html#window">window</A> will switch to the same value. There is no need to set
the <A HREF="#'makeprg'">'makeprg'</A> option in the other C source <A HREF="windows.html#window">window</A> too.
However, if you start editing a <A HREF="if_perl.html#Perl">Perl</A> file in a new <A HREF="windows.html#window">window</A>, you want to use
another <A HREF="#'makeprg'">'makeprg'</A> for <A HREF="motion.html#it">it</A>, without <A HREF="change.html#changing">changing</A> the value used for the C source
files. You use this command:
<B> :setlocal makeprg=perlmake</B>
You can switch back to using the global value by making the local value empty:
<B> :setlocal makeprg=</B>
This only works for a <A HREF="eval.html#string">string</A> option. For a <A HREF="#boolean">boolean</A> option you need to use the
"<A HREF="change.html#<"><</A>" flag, like this:
<B> :setlocal autoread<</B>
Note that for non-boolean <A HREF="#options">options</A> using "<A HREF="change.html#<"><</A>" copies the global value to the
local value, <A HREF="motion.html#it">it</A> doesn't switch back to using the global value (that matters
when the global value changes later). You can also use:
<B> :set path<</B>
This will make the local value of <A HREF="#'path'">'path'</A> empty, so that the global value is
used. Thus <A HREF="motion.html#it">it</A> does the same <A HREF="motion.html#as">as</A>:
<B> :setlocal path=</B>
Note: In the future more global <A HREF="#options">options</A> can be made <A HREF="#global-local">global-local</A>. Using
"<A HREF="#:setlocal">:setlocal</A>" on a global option might work differently then.
Setting the <A HREF="filetype.html#filetype">filetype</A>
:setf[iletype] [FALLBACK] {filetype} *<A NAME=":setf"></A><B>:setf</B>* *<A NAME=":setfiletype"></A><B>:setfiletype</B>*
Set the <A HREF="#'filetype'">'filetype'</A> option to {filetype}, but only if
not done yet in a sequence of (nested) autocommands.
This is short for:
<B> :if !did_filetype()</B>
<B> : setlocal filetype={filetype}</B>
<B> :endif</B>
This command is used in a filetype.vim file to avoid
setting the <A HREF="#'filetype'">'filetype'</A> option <A HREF="if_cscop.html#twice">twice</A>, causing different
settings and <A HREF="syntax.html#syntax">syntax</A> files to be loaded.
When the optional FALLBACK argument is present, a
later <A HREF="#:setfiletype">:setfiletype</A> command will override the
<A HREF="#'filetype'">'filetype'</A>. This is to used for <A HREF="filetype.html#filetype">filetype</A> detections
that are just a guess. |<A HREF="eval.html#did_filetype()">did_filetype()</A>| will return
false after this command.
{not in Vi}
*<A NAME="option-window"></A><B>option-window</B>* *<A NAME="optwin"></A><B>optwin</B>*
:bro[wse] se[t] *<A NAME=":set-browse"></A><B>:set-browse</B>* *<A NAME=":browse-set"></A><B>:browse-set</B>* *<A NAME=":opt"></A><B>:opt</B>* *<A NAME=":options"></A><B>:options</B>*
:opt[ions] Open a <A HREF="windows.html#window">window</A> for viewing and setting all <A HREF="#options">options</A>.
Options are grouped by function.
Offers short help for each option. Hit <A HREF="motion.html#<CR>"><CR></A> on the
short help to open a help <A HREF="windows.html#window">window</A> with more help for
the option.
Modify the value of the option and hit <A HREF="motion.html#<CR>"><CR></A> on the
"set" line to set the new value. For <A HREF="windows.html#window">window</A> and
buffer specific <A HREF="#options">options</A>, the last accessed <A HREF="windows.html#window">window</A> is
used to set the option value in, unless this is a help
<A HREF="windows.html#window">window</A>, in which <A HREF="change.html#case">case</A> the <A HREF="windows.html#window">window</A> below help <A HREF="windows.html#window">window</A> is
used (skipping the <A HREF="#option-window">option-window</A>).
{not available when compiled without the |<A HREF="various.html#+eval">+eval</A>| or
|<A HREF="various.html#+autocmd">+autocmd</A>| features}
*<A NAME="$HOME"></A><B>$HOME</B>*
Using "<A HREF="change.html#~">~</A>" is like using "<A HREF="#$HOME">$HOME</A>", but <A HREF="motion.html#it">it</A> is only recognized at the start of an
option and after a space or comma.
On <A HREF="os_unix.html#Unix">Unix</A> systems "~user" can be used too. It is replaced by the home directory
of user "user". Example:
<B> :set path=~mool/include,/usr/include,.</B>
On <A HREF="os_unix.html#Unix">Unix</A> systems the form "${HOME}" can be used too. The name between <A HREF="intro.html#{}">{}</A> can
contain non-id characters then. Note that if you want to use this for the
"<A HREF="editing.html#gf">gf</A>" command, you need to add the '<A HREF="motion.html#{">{</A>' and '<A HREF="motion.html#}">}</A>' characters to <A HREF="#'isfname'">'isfname'</A>.
NOTE: expanding environment <A HREF="eval.html#variables">variables</A> and "~/" is only done with the "<A HREF="#:set">:set</A>"
command, not when assigning a value to an option with "<A HREF="eval.html#:let">:let</A>".
*<A NAME="$HOME-windows"></A><B>$HOME-windows</B>*
On <A HREF="os_win32.html#MS-Windows">MS-Windows</A>, if <A HREF="#$HOME">$HOME</A> is not defined <A HREF="motion.html#as">as</A> an environment variable, then
at runtime Vim will set <A HREF="motion.html#it">it</A> to the expansion of $HOMEDRIVE$HOMEPATH.
If $HOMEDRIVE is not set then $USERPROFILE is used.
This expanded value is not exported to the environment, this matters when
running an external command:
<B> :echo system('set | findstr ^HOME=')</B>
and
<B> :echo luaeval('os.getenv("HOME")')</B>
should echo nothing (an empty <A HREF="eval.html#string">string</A>) despite exists('$HOME') being true.
When setting <A HREF="#$HOME">$HOME</A> to a non-empty <A HREF="eval.html#string">string</A> <A HREF="motion.html#it">it</A> will be exported to the
subprocesses.
Note the maximum length of an expanded option is limited. How much depends on
the system, mostly <A HREF="motion.html#it">it</A> is something like 256 or 1024 characters.
*<A NAME=":fix"></A><B>:fix</B>* *<A NAME=":fixdel"></A><B>:fixdel</B>*
:fix[del] Set the value of <A HREF="term.html#'t_kD'">'t_kD'</A>:
<B><FONT COLOR="PURPLE"> 't_kb' is 't_kD' becomes </FONT></B>
CTRL-? <A HREF="motion.html#CTRL-H">CTRL-H</A>
not CTRL-? CTRL-?
(CTRL-? is 0177 <A HREF="eval.html#octal">octal</A>, 0x7f hex) {not in Vi}
If your delete key <A HREF="terminal.html#terminal">terminal</A> code is wrong, but the
code for backspace is alright, you can put this in
your <A HREF="starting.html#.vimrc">.vimrc</A>:
<B> :fixdel</B>
This works no matter what the actual code for
backspace is.
If the backspace key <A HREF="terminal.html#terminal">terminal</A> code is wrong you can
use this:
<B> :if &term == "termname"</B>
<B> : set t_kb=^V<BS></B>
<B> : fixdel</B>
<B> :endif</B>
Where "^V" is <A HREF="visual.html#CTRL-V">CTRL-V</A> and "<A HREF="motion.html#<BS>"><BS></A>" is the backspace key
(don't type four characters!). <A HREF="insert.html#Replace">Replace</A> "termname"
with your <A HREF="terminal.html#terminal">terminal</A> name.
If your <Delete> key sends a strange key sequence (not
CTRL-? or <A HREF="motion.html#CTRL-H">CTRL-H</A>) you cannot use "<A HREF="#:fixdel">:fixdel</A>". Then use:
<B> :if &term == "termname"</B>
<B> : set t_kD=^V<Delete></B>
<B> :endif</B>
Where "^V" is <A HREF="visual.html#CTRL-V">CTRL-V</A> and "<Delete>" is the delete key
(don't type eight characters!). <A HREF="insert.html#Replace">Replace</A> "termname"
with your <A HREF="terminal.html#terminal">terminal</A> name.
*<A NAME="Linux-backspace"></A><B>Linux-backspace</B>*
Note about Linux: By default the backspace key
produces CTRL-?, which is wrong. You can fix <A HREF="motion.html#it">it</A> by
putting this line in your rc.local:
<B> echo "keycode 14 = BackSpace" | loadkeys</B>
*<A NAME="NetBSD-backspace"></A><B>NetBSD-backspace</B>*
Note about NetBSD: If your backspace doesn't produce
the right code, try this:
<B> xmodmap -e "keycode 22 = BackSpace"</B>
If this works, add this in your .Xmodmap file:
<B> keysym 22 = BackSpace</B>
You need to restart for this to take effect.
==============================================================================
2. Automatically setting <A HREF="#options">options</A> *<A NAME="auto-setting"></A><B>auto-setting</B>*
Besides <A HREF="change.html#changing">changing</A> <A HREF="#options">options</A> with the "<A HREF="#:set">:set</A>" command, there are three alternatives
to set <A HREF="#options">options</A> automatically for one or more files:
1. When starting Vim initializations are read from various places. See
|<A HREF="starting.html#initialization">initialization</A>|. Most of them are performed for all editing sessions,
and some of them depend on the directory where Vim is started.
You can create an <A HREF="starting.html#initialization">initialization</A> file with |<A HREF="starting.html#:mkvimrc">:mkvimrc</A>|, |<A HREF="starting.html#:mkview">:mkview</A>| and
|<A HREF="starting.html#:mksession">:mksession</A>|.
2. If you start editing a new file, the automatic commands are executed.
This can be used to set <A HREF="#options">options</A> for files matching a particular <A HREF="pattern.html#pattern">pattern</A> and
many other things. See |<A HREF="autocmd.html#autocommand">autocommand</A>|.
3. If you start editing a new file, and the <A HREF="#'modeline'">'modeline'</A> option is on, a
number of lines at the beginning and end of the file are checked for
modelines. This is explained here.
*<A NAME="modeline"></A><B>modeline</B>* *<A NAME="vim:"></A><B>vim:</B>* *<A NAME="vi:"></A><B>vi:</B>* *<A NAME="ex:"></A><B>ex:</B>* *<A NAME="E520"></A><B>E520</B>*
There are two forms of modelines. The first form:
[text]{white}{vi:|vim:|ex:}[white]{options}
[text] any text or empty
{white} at least one blank character (<Space> or <A HREF="motion.html#<Tab>"><Tab></A>)
{vi:|vim:|ex:} the <A HREF="eval.html#string">string</A> "<A HREF="#vi:">vi:</A>", "<A HREF="#vim:">vim:</A>" or "<A HREF="#ex:">ex:</A>"
[white] optional white space
{options} a <A HREF="eval.html#list">list</A> of option settings, separated with white space
or '<A HREF="cmdline.html#:">:</A>', where each part between '<A HREF="cmdline.html#:">:</A>' is the argument
for a "<A HREF="#:set">:set</A>" command (can be empty)
Examples:
<B><FONT COLOR="PURPLE"> vi:noai:sw=3 ts=6 </FONT></B>
<B><FONT COLOR="PURPLE"> vim: tw=77 </FONT></B>
The second form (this is compatible with some versions of Vi):
[text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
[text] any text or empty
{white} at least one blank character (<Space> or <A HREF="motion.html#<Tab>"><Tab></A>)
{vi:|vim:|Vim:|ex:} the <A HREF="eval.html#string">string</A> "<A HREF="#vi:">vi:</A>", "<A HREF="#vim:">vim:</A>", "Vim:" or "<A HREF="#ex:">ex:</A>"
[white] optional white space
se[t] the <A HREF="eval.html#string">string</A> "set " or "se " (note the space); When
"Vim" is used <A HREF="motion.html#it">it</A> must be "set".
{options} a <A HREF="eval.html#list">list</A> of <A HREF="#options">options</A>, separated with white space, which
is the argument for a "<A HREF="#:set">:set</A>" command
: a colon
[text] any text or empty
Examples:
<B><FONT COLOR="PURPLE"> /* vim: set ai tw=75: */ </FONT></B>
<B><FONT COLOR="PURPLE"> /* Vim: set ai tw=75: */ </FONT></B>
The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
chance that a normal <A HREF="motion.html#word">word</A> like "lex:" is caught. There is one exception:
"<A HREF="#vi:">vi:</A>" and "<A HREF="#vim:">vim:</A>" can also be at the start of the line (for compatibility with
version 3.0). Using "<A HREF="#ex:">ex:</A>" at the start of the line will be ignored (this
could be short for "example:").
*<A NAME="modeline-local"></A><B>modeline-local</B>*
The <A HREF="#options">options</A> are set like with "<A HREF="#:setlocal">:setlocal</A>": The new value only applies to the
buffer and <A HREF="windows.html#window">window</A> that contain the file. Although it's possible to set global
<A HREF="#options">options</A> from a <A HREF="#modeline">modeline</A>, this is unusual. If you have two <A HREF="windows.html#windows">windows</A> open and
the files in <A HREF="motion.html#it">it</A> set the same global option to a different value, the result
depends on which one was opened last.
When editing a file that was already loaded, only the window-local <A HREF="#options">options</A>
from the <A HREF="#modeline">modeline</A> are used. Thus if you manually changed a buffer-local
option after opening the file, <A HREF="motion.html#it">it</A> won't be changed if you edit the same buffer
in another <A HREF="windows.html#window">window</A>. But window-local <A HREF="#options">options</A> will be set.
*<A NAME="modeline-version"></A><B>modeline-version</B>*
If the <A HREF="#modeline">modeline</A> is only to be used for some versions of Vim, the version
number can be specified where "<A HREF="#vim:">vim:</A>" or "Vim:" is used:
vim{vers}: version {vers} or later
vim<{vers}: version before {vers}
vim={vers}: version {vers}
vim>{vers}: version after {vers}
{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
For example, to use a <A HREF="#modeline">modeline</A> only for Vim 7.0:
<B><FONT COLOR="PURPLE"> /* vim700: set foldmethod=marker */ </FONT></B>
To use a <A HREF="#modeline">modeline</A> for Vim after version 7.2:
<B><FONT COLOR="PURPLE"> /* vim>702: set cole=2: */ </FONT></B>
There can be no blanks between "vim" and the "<A HREF="cmdline.html#:">:</A>".
The number of lines that are checked can be set with the <A HREF="#'modelines'">'modelines'</A> option.
If <A HREF="#'modeline'">'modeline'</A> is off or <A HREF="#'modelines'">'modelines'</A> is 0 no lines are checked.
Note that for the first form all of the rest of the line is used, thus a line
like:
<B><FONT COLOR="PURPLE"> /* vi:ts=4: */ </FONT></B>
will give an error message for the trailing "*/". This line is OK:
<B><FONT COLOR="PURPLE"> /* vi:set ts=4: */ </FONT></B>
If an error is detected the rest of the line is skipped.
If you want to include a '<A HREF="cmdline.html#:">:</A>' in a set command precede <A HREF="motion.html#it">it</A> with a '\'. The
<A HREF="intro.html#backslash">backslash</A> in front of the '<A HREF="cmdline.html#:">:</A>' will be removed. Example:
<B><FONT COLOR="PURPLE"> /* vi:set dir=c\:\tmp: */ </FONT></B>
This sets the <A HREF="#'dir'">'dir'</A> option to "c:\tmp". Only a single <A HREF="intro.html#backslash">backslash</A> before the
'<A HREF="cmdline.html#:">:</A>' is removed. Thus to include "\:" you have to specify "\\:".
No other commands than "set" are supported, for security reasons (somebody
might create a Trojan horse text file with modelines). And not all <A HREF="#options">options</A>
can be set. For some <A HREF="#options">options</A> a flag is set, so that when it's used the
|<A HREF="eval.html#sandbox">sandbox</A>| is effective. Still, there is always a small risk that a <A HREF="#modeline">modeline</A>
causes trouble. E.g., when some joker sets <A HREF="#'textwidth'">'textwidth'</A> to 5 all your lines
are wrapped unexpectedly. So disable modelines before editing untrusted text.
The mail <A HREF="usr_41.html#ftplugin">ftplugin</A> does this, for example.
Hint: If you would like to <A HREF="diff.html#do">do</A> something else than setting an option, you could
define an <A HREF="autocmd.html#autocommand">autocommand</A> that checks the file for a specific <A HREF="eval.html#string">string</A>. For
example:
<B> au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif</B>
And define a function SetVar() that does something with the line containing
"VAR".
==============================================================================
3. Options summary *<A NAME="option-summary"></A><B>option-summary</B>*
In the <A HREF="eval.html#list">list</A> below all the <A HREF="#options">options</A> are mentioned with their full name and with
an abbreviation if there is one. Both forms may be used.
In this document when a <A HREF="#boolean">boolean</A> option is "set" that means that "<A HREF="#:set">:set</A> <A HREF="intro.html#'option'">option</A>"
is entered. When an option is "reset", "<A HREF="#:set">:set</A> nooption" is used.
For some <A HREF="#options">options</A> there are two default values: The "Vim default", which is
used when <A HREF="#'compatible'">'compatible'</A> is not set, and the "<A HREF="intro.html#Vi">Vi</A> default", which is used when
<A HREF="#'compatible'">'compatible'</A> is set.
Most <A HREF="#options">options</A> are the same in all <A HREF="windows.html#windows">windows</A> and <A HREF="windows.html#buffers">buffers</A>. There are a few that
are specific to how the text is presented in a <A HREF="windows.html#window">window</A>. These can be set to a
different value in each <A HREF="windows.html#window">window</A>. For example the <A HREF="#'list'">'list'</A> option can be set in
one <A HREF="windows.html#window">window</A> and reset in another for the same text, giving both types of <A HREF="starting.html#view">view</A>
at the same time. There are a few <A HREF="#options">options</A> that are specific to a certain
file. These can have a different value for each file or buffer. For example
the <A HREF="#'textwidth'">'textwidth'</A> option can be 78 for a normal text file and 0 for a C
program.
global one option for all <A HREF="windows.html#buffers">buffers</A> and <A HREF="windows.html#windows">windows</A>
local to <A HREF="windows.html#window">window</A> each <A HREF="windows.html#window">window</A> has its own copy of this option
local to buffer each buffer has its own copy of this option
When creating a new <A HREF="windows.html#window">window</A> the option values from the currently active <A HREF="windows.html#window">window</A>
are used <A HREF="motion.html#as">as</A> a default value for the window-specific <A HREF="#options">options</A>. For the
buffer-specific <A HREF="#options">options</A> this depends on the '<A HREF="change.html#s">s</A>' and '<A HREF="change.html#S">S</A>' flags in the
<A HREF="#'cpoptions'">'cpoptions'</A> option. If '<A HREF="change.html#s">s</A>' is included (which is the default) the values for
buffer <A HREF="#options">options</A> are copied from the currently active buffer when a buffer is
first entered. If '<A HREF="change.html#S">S</A>' is present the <A HREF="#options">options</A> are copied each time the buffer
is entered, this is almost like having global <A HREF="#options">options</A>. If '<A HREF="change.html#s">s</A>' and '<A HREF="change.html#S">S</A>' are not
present, the <A HREF="#options">options</A> are copied from the currently active buffer when the
buffer is created.
Hidden <A HREF="#options">options</A> *<A NAME="hidden-options"></A><B>hidden-options</B>*
Not all <A HREF="#options">options</A> are supported in all versions. This depends on the supported
features and sometimes on the system. A remark about this is in curly braces
below. When an option is not supported <A HREF="motion.html#it">it</A> may still be set without getting an
error, this is called a hidden option. You can't get the value of a hidden
option though, <A HREF="motion.html#it">it</A> is not stored.
To test if option "foo" can be used with "<A HREF="#:set">:set</A>" use something like this:
<B> if exists('&foo')</B>
This also returns true for a hidden option. To test if option "foo" is really
supported use something like this:
<B> if exists('+foo')</B>
*<A NAME="E355"></A><B>E355</B>*
A jump table for the <A HREF="#options">options</A> with a short description can be found at |<A HREF="quickref.html#Q_op">Q_op</A>|.
*<A NAME="'aleph'"></A><B>'aleph'</B>* *<A NAME="'al'"></A><B>'al'</B>* *<A NAME="aleph"></A><B>aleph</B>* *<A NAME="Aleph"></A><B>Aleph</B>*
<A HREF="#'aleph'">'aleph'</A> <A HREF="#'al'">'al'</A> number (default 128 for <A HREF="os_msdos.html#MS-DOS">MS-DOS</A>, 224 otherwise)
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+rightleft">+rightleft</A>|
feature}
The ASCII code for the first <A HREF="print.html#letter">letter</A> of the Hebrew alphabet. The
routine that maps the keyboard in Hebrew mode, both in <A HREF="insert.html#Insert">Insert</A> mode
(when hkmap is set) and on the command-line (when hitting CTRL-_)
outputs the Hebrew characters in the range [aleph..aleph+26].
aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
See |<A HREF="rileft.html">rileft.txt</A>|.
*<A NAME="'allowrevins'"></A><B>'allowrevins'</B>* *<A NAME="'ari'"></A><B>'ari'</B>* *<A NAME="'noallowrevins'"></A><B>'noallowrevins'</B>* *<A NAME="'noari'"></A><B>'noari'</B>*
<A HREF="#'allowrevins'">'allowrevins'</A> <A HREF="#'ari'">'ari'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+rightleft">+rightleft</A>|
feature}
Allow CTRL-_ in <A HREF="insert.html#Insert">Insert</A> and <A HREF="cmdline.html#Command-line">Command-line</A> mode. This is default off, to
avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
into reverse <A HREF="insert.html#Insert">Insert</A> mode, and don't know how to get out. See
<A HREF="#'revins'">'revins'</A>.
NOTE: This option is reset when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'altkeymap'"></A><B>'altkeymap'</B>* *<A NAME="'akm'"></A><B>'akm'</B>* *<A NAME="'noaltkeymap'"></A><B>'noaltkeymap'</B>* *<A NAME="'noakm'"></A><B>'noakm'</B>*
<A HREF="#'altkeymap'">'altkeymap'</A> <A HREF="#'akm'">'akm'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+farsi">+farsi</A>|
feature}
When on, the second language is <A HREF="farsi.html#Farsi">Farsi</A>. In editing mode CTRL-_ toggles
the keyboard map between <A HREF="farsi.html#Farsi">Farsi</A> and English, when <A HREF="#'allowrevins'">'allowrevins'</A> set.
When off, the keyboard map toggles between Hebrew and English. This
is useful to start the Vim in native mode i.e. English (left-to-right
mode) and have default second language <A HREF="farsi.html#Farsi">Farsi</A> or Hebrew (right-to-left
mode). See |<A HREF="farsi.html">farsi.txt</A>|.
*<A NAME="'ambiwidth'"></A><B>'ambiwidth'</B>* *<A NAME="'ambw'"></A><B>'ambw'</B>*
<A HREF="#'ambiwidth'">'ambiwidth'</A> <A HREF="#'ambw'">'ambw'</A> <A HREF="eval.html#string">string</A> (default: "single")
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+multi_byte">+multi_byte</A>|
feature}
Only effective when <A HREF="#'encoding'">'encoding'</A> is "<A HREF="mbyte.html#utf-8">utf-8</A>" or another <A HREF="mbyte.html#Unicode">Unicode</A> encoding.
Tells Vim what to <A HREF="diff.html#do">do</A> with characters with East Asian Width Class
Ambiguous (such <A HREF="motion.html#as">as</A> Euro, Registered Sign, Copyright Sign, Greek
letters, Cyrillic letters).
There are currently two possible values:
"single": Use the same width <A HREF="motion.html#as">as</A> characters in US-ASCII. This is
expected by most users.
"double": Use <A HREF="if_cscop.html#twice">twice</A> the width of ASCII characters.
*<A NAME="E834"></A><B>E834</B>* *<A NAME="E835"></A><B>E835</B>*
The value "double" cannot be used if <A HREF="#'listchars'">'listchars'</A> or <A HREF="#'fillchars'">'fillchars'</A>
contains a character that would be double width.
There are a number of CJK fonts for which the width of glyphs for
those characters are solely based on how many octets they take in
legacy/traditional CJK encodings. In those encodings, Euro,
Registered sign, Greek/Cyrillic letters are represented by two octets,
therefore those fonts have "wide" glyphs for them. This is also
true of some line drawing characters used to make tables in text
file. Therefore, when a CJK font is used for <A HREF="gui.html#GUI">GUI</A> Vim or
Vim is running inside a <A HREF="terminal.html#terminal">terminal</A> (emulators) that uses a CJK font
(or Vim is run inside an xterm invoked with "-cjkwidth" option.),
this option should be set to "double" to match the width perceived
by Vim with the width of glyphs in the font. Perhaps <A HREF="motion.html#it">it</A> also has
to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
when the system <A HREF="mbyte.html#locale">locale</A> is set to one of CJK locales. See <A HREF="mbyte.html#Unicode">Unicode</A>
Standard Annex #11 <A HREF="http://www.unicode.org/reports/tr11">http://www.unicode.org/reports/tr11</A>.
Vim may set this option automatically at <A HREF="starting.html#startup">startup</A> time when Vim is
compiled with the |<A HREF="various.html#+termresponse">+termresponse</A>| feature and if |<A HREF="term.html#t_u7">t_u7</A>| is set to the
<A HREF="intro.html#escape">escape</A> sequence to request cursor position report. The response can
be found in |<A HREF="eval.html#v:termu7resp">v:termu7resp</A>|.
*<A NAME="'antialias'"></A><B>'antialias'</B>* *<A NAME="'anti'"></A><B>'anti'</B>* *<A NAME="'noantialias'"></A><B>'noantialias'</B>* *<A NAME="'noanti'"></A><B>'noanti'</B>*
<A HREF="#'antialias'">'antialias'</A> <A HREF="#'anti'">'anti'</A> <A HREF="#boolean">boolean</A> (default: off)
global
{not in Vi}
{only available when compiled with <A HREF="gui.html#GUI">GUI</A> enabled
on <A HREF="os_mac.html#Mac">Mac</A> OS X}
This option only has an effect in the <A HREF="gui.html#GUI">GUI</A> version of Vim on <A HREF="os_mac.html#Mac">Mac</A> OS X
v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
which can be easier to read at certain sizes on certain displays.
Setting this option can sometimes cause problems if <A HREF="#'guifont'">'guifont'</A> is set
to its default (empty <A HREF="eval.html#string">string</A>).
NOTE: This option is reset when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'autochdir'"></A><B>'autochdir'</B>* *<A NAME="'acd'"></A><B>'acd'</B>* *<A NAME="'noautochdir'"></A><B>'noautochdir'</B>* *<A NAME="'noacd'"></A><B>'noacd'</B>*
<A HREF="#'autochdir'">'autochdir'</A> <A HREF="#'acd'">'acd'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
{only available when compiled with <A HREF="motion.html#it">it</A>, use
exists("+autochdir") to check}
When on, Vim will change the current working directory whenever you
open a file, switch <A HREF="windows.html#buffers">buffers</A>, delete a buffer or open/close a <A HREF="windows.html#window">window</A>.
It will change to the directory containing the file which was opened
or selected.
Note: When this option is on some plugins may not work.
*<A NAME="'arabic'"></A><B>'arabic'</B>* *<A NAME="'arab'"></A><B>'arab'</B>* *<A NAME="'noarabic'"></A><B>'noarabic'</B>* *<A NAME="'noarab'"></A><B>'noarab'</B>*
<A HREF="#'arabic'">'arabic'</A> <A HREF="#'arab'">'arab'</A> <A HREF="#boolean">boolean</A> (default off)
local to <A HREF="windows.html#window">window</A>
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+arabic">+arabic</A>|
feature}
This option can be set to start editing <A HREF="arabic.html#Arabic">Arabic</A> text.
Setting this option will:
- Set the <A HREF="#'rightleft'">'rightleft'</A> option, unless <A HREF="#'termbidi'">'termbidi'</A> is set.
- Set the <A HREF="#'arabicshape'">'arabicshape'</A> option, unless <A HREF="#'termbidi'">'termbidi'</A> is set.
- Set the <A HREF="#'keymap'">'keymap'</A> option to "arabic"; in <A HREF="insert.html#Insert">Insert</A> mode <A HREF="editing.html#CTRL-^">CTRL-^</A> toggles
between typing English and <A HREF="arabic.html#Arabic">Arabic</A> key <A HREF="map.html#mapping">mapping</A>.
- Set the <A HREF="#'delcombine'">'delcombine'</A> option
Note that <A HREF="#'encoding'">'encoding'</A> must be "<A HREF="mbyte.html#utf-8">utf-8</A>" for working with <A HREF="arabic.html#Arabic">Arabic</A> text.
Resetting this option will:
- Reset the <A HREF="#'rightleft'">'rightleft'</A> option.
- Disable the use of <A HREF="#'keymap'">'keymap'</A> (without <A HREF="change.html#changing">changing</A> its value).
Note that <A HREF="#'arabicshape'">'arabicshape'</A> and <A HREF="#'delcombine'">'delcombine'</A> are not reset (it is a global
option).
NOTE: This option is reset when <A HREF="#'compatible'">'compatible'</A> is set.
Also see |<A HREF="arabic.html">arabic.txt</A>|.
*<A NAME="'arabicshape'"></A><B>'arabicshape'</B>* *<A NAME="'arshape'"></A><B>'arshape'</B>*
*<A NAME="'noarabicshape'"></A><B>'noarabicshape'</B>* *<A NAME="'noarshape'"></A><B>'noarshape'</B>*
<A HREF="#'arabicshape'">'arabicshape'</A> <A HREF="#'arshape'">'arshape'</A> <A HREF="#boolean">boolean</A> (default on)
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+arabic">+arabic</A>|
feature}
When on and <A HREF="#'termbidi'">'termbidi'</A> is off, the required visual character
corrections that need to take place for displaying the <A HREF="arabic.html#Arabic">Arabic</A> language
take effect. Shaping, in essence, gets enabled; the term is a broad
one which encompasses:
<A HREF="motion.html#a)">a)</A> the changing/morphing of characters based on their location
within a <A HREF="motion.html#word">word</A> (initial, medial, final and stand-alone).
<A HREF="motion.html#b">b</A>) the enabling of the ability to compose characters
<A HREF="change.html#c">c</A>) the enabling of the required combining of some characters
When disabled the display shows each character's true stand-alone
form.
<A HREF="arabic.html#Arabic">Arabic</A> is a complex language which requires other settings, for
further details see |<A HREF="arabic.html">arabic.txt</A>|.
NOTE: This option is set when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'autoindent'"></A><B>'autoindent'</B>* *<A NAME="'ai'"></A><B>'ai'</B>* *<A NAME="'noautoindent'"></A><B>'noautoindent'</B>* *<A NAME="'noai'"></A><B>'noai'</B>*
<A HREF="#'autoindent'">'autoindent'</A> <A HREF="#'ai'">'ai'</A> <A HREF="#boolean">boolean</A> (default off)
local to buffer
Copy indent from current line when starting a new line (typing <A HREF="motion.html#<CR>"><CR></A>
in <A HREF="insert.html#Insert">Insert</A> mode or when using the "<A HREF="insert.html#o">o</A>" or "<A HREF="insert.html#O">O</A>" command). If you <A HREF="diff.html#do">do</A> not
type anything on the new line except <A HREF="motion.html#<BS>"><BS></A> or <A HREF="scroll.html#CTRL-D">CTRL-D</A> and then type
<A HREF="intro.html#<Esc>"><Esc></A>, <A HREF="motion.html#CTRL-O">CTRL-O</A> or <A HREF="motion.html#<CR>"><CR></A>, the indent is deleted again. Moving the cursor
to another line has the same effect, unless the '<A HREF="insert.html#I">I</A>' flag is included
in <A HREF="#'cpoptions'">'cpoptions'</A>.
When autoindent is on, <A HREF="change.html#formatting">formatting</A> (with the "<A HREF="change.html#gq">gq</A>" command or when you
reach <A HREF="#'textwidth'">'textwidth'</A> in <A HREF="insert.html#Insert">Insert</A> mode) uses the indentation of the first
line.
When <A HREF="#'smartindent'">'smartindent'</A> or <A HREF="#'cindent'">'cindent'</A> is on the indent is changed in
a different way.
The <A HREF="#'autoindent'">'autoindent'</A> option is reset when the <A HREF="#'paste'">'paste'</A> option is set and
restored when <A HREF="#'paste'">'paste'</A> is reset.
{small difference from <A HREF="intro.html#Vi">Vi</A>: After the indent is deleted when typing
<A HREF="intro.html#<Esc>"><Esc></A> or <A HREF="motion.html#<CR>"><CR></A>, the cursor position when moving up or down is after the
deleted indent; <A HREF="intro.html#Vi">Vi</A> puts the cursor somewhere in the deleted indent}.
*<A NAME="'autoread'"></A><B>'autoread'</B>* *<A NAME="'ar'"></A><B>'ar'</B>* *<A NAME="'noautoread'"></A><B>'noautoread'</B>* *<A NAME="'noar'"></A><B>'noar'</B>*
<A HREF="#'autoread'">'autoread'</A> <A HREF="#'ar'">'ar'</A> <A HREF="#boolean">boolean</A> (default off)
global or local to buffer |<A HREF="#global-local">global-local</A>|
{not in Vi}
When a file has been detected to have been changed outside of Vim and
<A HREF="motion.html#it">it</A> has not been changed inside of Vim, automatically read <A HREF="motion.html#it">it</A> again.
When the file has been deleted this is not done. |<A HREF="editing.html#timestamp">timestamp</A>|
If this option has a local value, use this command to switch back to
using the global value:
<B> :set autoread<</B>
*<A NAME="'autowrite'"></A><B>'autowrite'</B>* *<A NAME="'aw'"></A><B>'aw'</B>* *<A NAME="'noautowrite'"></A><B>'noautowrite'</B>* *<A NAME="'noaw'"></A><B>'noaw'</B>*
<A HREF="#'autowrite'">'autowrite'</A> <A HREF="#'aw'">'aw'</A> <A HREF="#boolean">boolean</A> (default off)
global
Write the contents of the file, if <A HREF="motion.html#it">it</A> has been modified, on each
<A HREF="editing.html#:next">:next</A>, <A HREF="editing.html#:rewind">:rewind</A>, <A HREF="editing.html#:last">:last</A>, <A HREF="editing.html#:first">:first</A>, <A HREF="editing.html#:previous">:previous</A>, <A HREF="starting.html#:stop">:stop</A>, <A HREF="starting.html#:suspend">:suspend</A>, <A HREF="tagsrch.html#:tag">:tag</A>, <A HREF="various.html#:!">:!</A>,
<A HREF="quickfix.html#:make">:make</A>, <A HREF="tagsrch.html#CTRL-]">CTRL-]</A> and <A HREF="editing.html#CTRL-^">CTRL-^</A> command; and when a <A HREF="windows.html#:buffer">:buffer</A>, <A HREF="motion.html#CTRL-O">CTRL-O</A>, <A HREF="motion.html#CTRL-I">CTRL-I</A>,
'{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
Note that for some commands the <A HREF="#'autowrite'">'autowrite'</A> option is not used, see
<A HREF="#'autowriteall'">'autowriteall'</A> for that.
*<A NAME="'autowriteall'"></A><B>'autowriteall'</B>* *<A NAME="'awa'"></A><B>'awa'</B>* *<A NAME="'noautowriteall'"></A><B>'noautowriteall'</B>* *<A NAME="'noawa'"></A><B>'noawa'</B>*
<A HREF="#'autowriteall'">'autowriteall'</A> <A HREF="#'awa'">'awa'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
Like <A HREF="#'autowrite'">'autowrite'</A>, but also used for commands "<A HREF="editing.html#:edit">:edit</A>", "<A HREF="editing.html#:enew">:enew</A>", "<A HREF="editing.html#:quit">:quit</A>",
"<A HREF="editing.html#:qall">:qall</A>", "<A HREF="editing.html#:exit">:exit</A>", "<A HREF="editing.html#:xit">:xit</A>", "<A HREF="recover.html#:recover">:recover</A>" and closing the Vim <A HREF="windows.html#window">window</A>.
Setting this option also implies that Vim behaves like <A HREF="#'autowrite'">'autowrite'</A> has
been set.
*<A NAME="'background'"></A><B>'background'</B>* *<A NAME="'bg'"></A><B>'bg'</B>*
<A HREF="#'background'">'background'</A> <A HREF="#'bg'">'bg'</A> <A HREF="eval.html#string">string</A> (default "dark" or "light", see below)
global
{not in Vi}
When set to "dark", Vim will try to use colors that look good on a
dark background. When set to "light", Vim will try to use colors that
look good on a light background. Any other value is illegal.
Vim tries to set the default value according to the <A HREF="terminal.html#terminal">terminal</A> used.
This will not always be correct.
Setting this option does not change the background color, <A HREF="motion.html#it">it</A> tells Vim
what the background color looks like. For <A HREF="change.html#changing">changing</A> the background
color, see |<A HREF="syntax.html#:hi-normal">:hi-normal</A>|.
When <A HREF="#'background'">'background'</A> is set Vim will adjust the default color groups for
the new value. But the colors used for <A HREF="syntax.html#syntax">syntax</A> highlighting will not
change. *<A NAME="g:colors_name"></A><B>g:colors_name</B>*
When a color scheme is loaded (the "<A HREF="#g:colors_name">g:colors_name</A>" variable is set)
setting <A HREF="#'background'">'background'</A> will cause the color scheme to be reloaded. If
the color scheme adjusts to the value of <A HREF="#'background'">'background'</A> this will work.
However, if the color scheme sets <A HREF="#'background'">'background'</A> itself the effect may
be undone. First delete the "<A HREF="#g:colors_name">g:colors_name</A>" variable when needed.
When setting <A HREF="#'background'">'background'</A> to the default value with:
<B> :set background&</B>
Vim will guess the value. In the <A HREF="gui.html#GUI">GUI</A> this should work correctly,
in other cases Vim might not be able to guess the right value.
When the |<A HREF="term.html#t_RB">t_RB</A>| option is set, Vim will use <A HREF="motion.html#it">it</A> to request the background
color from the <A HREF="terminal.html#terminal">terminal</A>. If the returned RGB value is dark/light and
<A HREF="#'background'">'background'</A> is not dark/light, <A HREF="#'background'">'background'</A> will be set and the
screen is redrawn. This may have side effects, make t_BG empty in
your <A HREF="starting.html#.vimrc">.vimrc</A> if you suspect this problem. The response to |<A HREF="term.html#t_RB">t_RB</A>| can
be found in |<A HREF="eval.html#v:termrbgresp">v:termrbgresp</A>|.
When starting the <A HREF="gui.html#GUI">GUI</A>, the default value for <A HREF="#'background'">'background'</A> will be
"light". When the value is not set in the <A HREF="gui.html#.gvimrc">.gvimrc</A>, and Vim detects
that the background is actually quite dark, <A HREF="#'background'">'background'</A> is set to
"dark". But this happens only AFTER the <A HREF="gui.html#.gvimrc">.gvimrc</A> file has been read
(because the <A HREF="windows.html#window">window</A> needs to be opened to find the actual background
color). To get around this, force the <A HREF="gui.html#GUI">GUI</A> <A HREF="windows.html#window">window</A> to be opened by
putting a "<A HREF="gui_x11.html#:gui">:gui</A>" command in the <A HREF="gui.html#.gvimrc">.gvimrc</A> file, before where the value
of <A HREF="#'background'">'background'</A> is used (e.g., before "<A HREF="syntax.html#:syntax">:syntax</A> on").
For <A HREF="os_msdos.html#MS-DOS">MS-DOS</A>, Windows and <A HREF="os_os2.html#OS/2">OS/2</A> the default is "dark".
For other systems "dark" is used when <A HREF="#'term'">'term'</A> is "linux",
"screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
background. Otherwise the default is "light".
The |<A HREF="terminal.html#:terminal">:terminal</A>| command and the |<A HREF="eval.html#term_start()">term_start()</A>| function use the
<A HREF="#'background'">'background'</A> value to decide whether the <A HREF="terminal.html#terminal">terminal</A> <A HREF="windows.html#window">window</A> will start
with a white or black background.
Normally this option would be set in the <A HREF="starting.html#.vimrc">.vimrc</A> file. Possibly
depending on the <A HREF="terminal.html#terminal">terminal</A> name. Example:
<B> :if &term == "pcterm"</B>
<B> : set background=dark</B>
<B> :endif</B>
When this option is set, the default settings for the highlight groups
will change. To use other settings, place "<A HREF="syntax.html#:highlight">:highlight</A>" commands AFTER
the setting of the <A HREF="#'background'">'background'</A> option.
This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
to select the colors for <A HREF="syntax.html#syntax">syntax</A> highlighting. After <A HREF="change.html#changing">changing</A> this
option, you must load syntax.vim again to see the result. This can be
done with "<A HREF="syntax.html#:syntax">:syntax</A> on".
*<A NAME="'backspace'"></A><B>'backspace'</B>* *<A NAME="'bs'"></A><B>'bs'</B>*
<A HREF="#'backspace'">'backspace'</A> <A HREF="#'bs'">'bs'</A> <A HREF="eval.html#string">string</A> (default "", set to "indent,eol,start"
in |<A HREF="defaults.html">defaults.vim</A>|)
global
{not in Vi}
Influences the working of <A HREF="motion.html#<BS>"><BS></A>, <A HREF="change.html#<Del>"><Del></A>, <A HREF="index.html#CTRL-W">CTRL-W</A> and <A HREF="scroll.html#CTRL-U">CTRL-U</A> in <A HREF="insert.html#Insert">Insert</A>
mode. This is a <A HREF="eval.html#list">list</A> of items, separated by commas. Each item allows
a way to backspace over something:
<B><FONT COLOR="PURPLE"> value effect </FONT></B>
indent allow backspacing over autoindent
eol allow backspacing over line breaks (join lines)
start allow backspacing over the start of insert; <A HREF="index.html#CTRL-W">CTRL-W</A> and <A HREF="scroll.html#CTRL-U">CTRL-U</A>
stop once at the start of insert.
When the value is empty, <A HREF="intro.html#Vi">Vi</A> compatible backspacing is used.
For backwards compatibility with version 5.4 and earlier:
<B><FONT COLOR="PURPLE"> value effect </FONT></B>
0 same <A HREF="motion.html#as">as</A> "<A HREF="#:set">:set</A> <A HREF="#'backspace'">backspace</A>=" (Vi compatible)
1 same <A HREF="motion.html#as">as</A> "<A HREF="#:set">:set</A> <A HREF="#'backspace'">backspace</A>=indent,eol"
2 same <A HREF="motion.html#as">as</A> "<A HREF="#:set">:set</A> <A HREF="#'backspace'">backspace</A>=indent,eol,start"
See |<A HREF="#:fixdel">:fixdel</A>| if your <A HREF="motion.html#<BS>"><BS></A> or <A HREF="change.html#<Del>"><Del></A> key does not <A HREF="diff.html#do">do</A> what you want.
NOTE: This option is set to "" when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'backup'"></A><B>'backup'</B>* *<A NAME="'bk'"></A><B>'bk'</B>* *<A NAME="'nobackup'"></A><B>'nobackup'</B>* *<A NAME="'nobk'"></A><B>'nobk'</B>*
<A HREF="#'backup'">'backup'</A> <A HREF="#'bk'">'bk'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
Make a <A HREF="editing.html#backup">backup</A> before overwriting a file. Leave <A HREF="motion.html#it">it</A> around after the
file has been successfully written. If you <A HREF="diff.html#do">do</A> not want to keep the
<A HREF="editing.html#backup">backup</A> file, but you <A HREF="diff.html#do">do</A> want a <A HREF="editing.html#backup">backup</A> while the file is being
written, reset this option and set the <A HREF="#'writebackup'">'writebackup'</A> option (this is
the default). If you <A HREF="diff.html#do">do</A> not want a <A HREF="editing.html#backup">backup</A> file at all reset both
<A HREF="#options">options</A> (use this if your file system is almost full). See the
|<A HREF="editing.html#backup-table">backup-table</A>| for more explanations.
When the <A HREF="#'backupskip'">'backupskip'</A> <A HREF="pattern.html#pattern">pattern</A> matches, a <A HREF="editing.html#backup">backup</A> is not made anyway.
When <A HREF="#'patchmode'">'patchmode'</A> is set, the <A HREF="editing.html#backup">backup</A> may be renamed to become the
oldest version of a file.
NOTE: This option is reset when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'backupcopy'"></A><B>'backupcopy'</B>* *<A NAME="'bkc'"></A><B>'bkc'</B>*
<A HREF="#'backupcopy'">'backupcopy'</A> <A HREF="#'bkc'">'bkc'</A> <A HREF="eval.html#string">string</A> (Vi default for <A HREF="os_unix.html#Unix">Unix</A>: "yes", otherwise: "auto")
global or local to buffer |<A HREF="#global-local">global-local</A>|
{not in Vi}
When <A HREF="editing.html#writing">writing</A> a file and a <A HREF="editing.html#backup">backup</A> is made, this option tells how it's
done. This is a comma separated <A HREF="eval.html#list">list</A> of words.
The main values are:
"yes" make a copy of the file and overwrite the original one
"no" rename the file and write a new one
"auto" one of the previous, what works best
Extra values that can be combined with the ones above are:
"breaksymlink" always break symlinks when <A HREF="editing.html#writing">writing</A>
"breakhardlink" always break hardlinks when <A HREF="editing.html#writing">writing</A>
Making a copy and overwriting the original file:
- Takes extra time to copy the file.
+ When the file has special attributes, is a (hard/symbolic) link or
has a resource <A HREF="os_unix.html#fork">fork</A>, all this is preserved.
- When the file is a link the <A HREF="editing.html#backup">backup</A> will have the name of the link,
not of the real file.
Renaming the file and <A HREF="editing.html#writing">writing</A> a new one:
+ It's fast.
- Sometimes not all attributes of the file can be copied to the new
file.
- When the file is a link the new file will not be a link.
The "auto" value is the middle way: When Vim sees that renaming file
is possible without side effects (the attributes can be passed on and
the file is not a link) that is used. When problems are expected, a
copy will be made.
The "breaksymlink" and "breakhardlink" values can be used in
combination with any of "yes", "no" and "auto". When included, they
force Vim to always break either symbolic or hard links by doing
exactly what the "no" option does, renaming the original file to
become the <A HREF="editing.html#backup">backup</A> and <A HREF="editing.html#writing">writing</A> a new file in its place. This can be
useful for example in source trees where all the files are symbolic or
hard links and any changes should stay in the local source tree, not
be propagated back to the original source.
*<A NAME="crontab"></A><B>crontab</B>*
One situation where "no" and "auto" will cause problems: A program
that opens a file, invokes Vim to edit that file, and then tests if
the open file was changed (through the file descriptor) will check the
<A HREF="editing.html#backup">backup</A> file instead of the newly created file. "<A HREF="#crontab">crontab</A> -e" is an
example.
When a copy is made, the original file is truncated and then filled
with the new text. This means that protection bits, owner and
symbolic links of the original file are unmodified. The <A HREF="editing.html#backup">backup</A> file
however, is a new file, owned by the user who edited the file. The
group of the <A HREF="editing.html#backup">backup</A> is set to the group of the original file. If this
fails, the protection bits for the group are made the same <A HREF="motion.html#as">as</A> for
others.
When the file is renamed this is the other way around: The <A HREF="editing.html#backup">backup</A> has
the same attributes of the original file, and the newly written file
is owned by the current user. When the file was a (hard/symbolic)
link, the new file will not! That's why the "auto" value doesn't
rename when the file is a link. The owner and group of the newly
written file will be set to the same ones <A HREF="motion.html#as">as</A> the original file, but
the system may refuse to <A HREF="diff.html#do">do</A> this. In that <A HREF="change.html#case">case</A> the "auto" value will
again not rename the file.
NOTE: This option is set to the <A HREF="intro.html#Vi">Vi</A> default value when <A HREF="#'compatible'">'compatible'</A> is
set and to the Vim default value when <A HREF="#'compatible'">'compatible'</A> is reset.
*<A NAME="'backupdir'"></A><B>'backupdir'</B>* *<A NAME="'bdir'"></A><B>'bdir'</B>*
<A HREF="#'backupdir'">'backupdir'</A> <A HREF="#'bdir'">'bdir'</A> <A HREF="eval.html#string">string</A> (default for <A HREF="os_amiga.html#Amiga">Amiga</A>: ".,t:",
for <A HREF="os_msdos.html#MS-DOS">MS-DOS</A> and <A HREF="os_win32.html#Win32">Win32</A>: ".,$TEMP,c:/tmp,c:/temp"
for <A HREF="os_unix.html#Unix">Unix</A>: ".,~/tmp,~/")
global
{not in Vi}
<A HREF="eval.html#List">List</A> of directories for the <A HREF="editing.html#backup">backup</A> file, separated with commas.
- The <A HREF="editing.html#backup">backup</A> file will be created in the first directory in the <A HREF="eval.html#list">list</A>
where this is possible. The directory must exist, Vim will not
create <A HREF="motion.html#it">it</A> for you.
- Empty means that no <A HREF="editing.html#backup">backup</A> file will be created ('patchmode' is
impossible!). Writing may fail because of this.
- A directory "<A HREF="repeat.html#.">.</A>" means to put the <A HREF="editing.html#backup">backup</A> file in the same directory
<A HREF="motion.html#as">as</A> the edited file.
- A directory starting with "./" (or ".\" for <A HREF="os_msdos.html#MS-DOS">MS-DOS</A> et al.) means to
put the <A HREF="editing.html#backup">backup</A> file relative to where the edited file is. The
leading "<A HREF="repeat.html#.">.</A>" is replaced with the path name of the edited file.
("." inside a directory name has no special meaning).
- Spaces after the comma are ignored, other spaces are considered part
of the directory name. To have a space at the start of a directory
name, precede <A HREF="motion.html#it">it</A> with a <A HREF="intro.html#backslash">backslash</A>.
- To include a comma in a directory name precede <A HREF="motion.html#it">it</A> with a <A HREF="intro.html#backslash">backslash</A>.
- A directory name may end in an '<A HREF="pattern.html#/">/</A>'.
- Environment <A HREF="eval.html#variables">variables</A> are expanded |<A HREF="#:set_env">:set_env</A>|.
- Careful with '\' characters, type one before a space, type two to
get one in the option (see |<A HREF="#option-backslash">option-backslash</A>|), for example:
<B> :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces</B>
- For backwards compatibility with Vim version 3.0 a '<A HREF="change.html#>">></A>' at the start
of the option is removed.
See also <A HREF="#'backup'">'backup'</A> and <A HREF="#'writebackup'">'writebackup'</A> <A HREF="#options">options</A>.
If you want to hide your <A HREF="editing.html#backup">backup</A> files on <A HREF="os_unix.html#Unix">Unix</A>, consider this value:
<B> :set backupdir=./.backup,~/.backup,.,/tmp</B>
You must create a ".backup" directory in each directory and in your
home directory for this to work properly.
The use of |<A HREF="#:set+=">:set+=</A>| and |<A HREF="#:set-=">:set-=</A>| is preferred when adding or removing
directories from the <A HREF="eval.html#list">list</A>. This avoids problems when a future version
uses another default.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'backupext'"></A><B>'backupext'</B>* *<A NAME="'bex'"></A><B>'bex'</B>* *<A NAME="E589"></A><B>E589</B>*
<A HREF="#'backupext'">'backupext'</A> <A HREF="#'bex'">'bex'</A> <A HREF="eval.html#string">string</A> (default "<A HREF="change.html#~">~</A>", for <A HREF="os_vms.html#VMS">VMS</A>: "<A HREF="motion.html#_">_</A>")
global
{not in Vi}
<A HREF="eval.html#String">String</A> which is appended to a file name to make the name of the
<A HREF="editing.html#backup">backup</A> file. The default is quite unusual, because this avoids
accidentally overwriting existing files with a <A HREF="editing.html#backup">backup</A> file. You might
prefer using ".bak", but make sure that you don't have files with
".bak" that you want to keep.
Only normal file name characters can be used, "/\*?[|<>" are illegal.
If you like to keep a lot of backups, you could use a <A HREF="autocmd.html#BufWritePre">BufWritePre</A>
<A HREF="autocmd.html#autocommand">autocommand</A> to change <A HREF="#'backupext'">'backupext'</A> just before <A HREF="editing.html#writing">writing</A> the file to
include a <A HREF="editing.html#timestamp">timestamp</A>.
<B> :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'</B>
Use <A HREF="#'backupdir'">'backupdir'</A> to put the <A HREF="editing.html#backup">backup</A> in a different directory.
*<A NAME="'backupskip'"></A><B>'backupskip'</B>* *<A NAME="'bsk'"></A><B>'bsk'</B>*
<A HREF="#'backupskip'">'backupskip'</A> <A HREF="#'bsk'">'bsk'</A> <A HREF="eval.html#string">string</A> (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+wildignore">+wildignore</A>|
feature}
A <A HREF="eval.html#list">list</A> of file patterns. When one of the patterns matches with the
name of the file which is written, no <A HREF="editing.html#backup">backup</A> file is created. Both
the specified file name and the full path name of the file are used.
The pattern is used like with |<A HREF="autocmd.html#:autocmd">:autocmd</A>|, see |<A HREF="autocmd.html#autocmd-patterns">autocmd-patterns</A>|.
Watch out for special characters, see |<A HREF="#option-backslash">option-backslash</A>|.
When $TMPDIR, $TMP or $TEMP is not defined, <A HREF="motion.html#it">it</A> is not used for the
default value. "/tmp/*" is only used for <A HREF="os_unix.html#Unix">Unix</A>.
WARNING: Not having a <A HREF="editing.html#backup">backup</A> file means that when Vim fails to write
your buffer correctly and then, for whatever reason, Vim exits, you
lose both the original file and what you were <A HREF="editing.html#writing">writing</A>. Only disable
backups if you don't care about losing the file.
Note that environment <A HREF="eval.html#variables">variables</A> are not expanded. If you want to use
<A HREF="#$HOME">$HOME</A> you must expand <A HREF="motion.html#it">it</A> explicitly, e.g.:
<B> :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'</B>
Note that the default also makes sure that "<A HREF="#crontab">crontab</A> -e" works (when a
<A HREF="editing.html#backup">backup</A> would be made by renaming the original file <A HREF="#crontab">crontab</A> won't see
the newly created file). Also see <A HREF="#'backupcopy'">'backupcopy'</A> and |<A HREF="#crontab">crontab</A>|.
*<A NAME="'balloondelay'"></A><B>'balloondelay'</B>* *<A NAME="'bdlay'"></A><B>'bdlay'</B>*
<A HREF="#'balloondelay'">'balloondelay'</A> <A HREF="#'bdlay'">'bdlay'</A> number (default: 600)
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+balloon_eval">+balloon_eval</A>|
feature}
Delay in milliseconds before a balloon may pop up. See |<A HREF="debugger.html#balloon-eval">balloon-eval</A>|.
*<A NAME="'ballooneval'"></A><B>'ballooneval'</B>* *<A NAME="'beval'"></A><B>'beval'</B>* *<A NAME="'noballooneval'"></A><B>'noballooneval'</B>* *<A NAME="'nobeval'"></A><B>'nobeval'</B>*
<A HREF="#'ballooneval'">'ballooneval'</A> <A HREF="#'beval'">'beval'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+balloon_eval">+balloon_eval</A>|
feature}
Switch on the |<A HREF="debugger.html#balloon-eval">balloon-eval</A>| functionality for the <A HREF="gui.html#GUI">GUI</A>.
*<A NAME="'balloonevalterm'"></A><B>'balloonevalterm'</B>* *<A NAME="'bevalterm'"></A><B>'bevalterm'</B>* *<A NAME="'noballoonevalterm'"></A><B>'noballoonevalterm'</B>*
*<A NAME="'nobevalterm'"></A><B>'nobevalterm'</B>*
<A HREF="#'balloonevalterm'">'balloonevalterm'</A> <A HREF="#'bevalterm'">'bevalterm'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
{only available when compiled with the
|<A HREF="various.html#+balloon_eval_term">+balloon_eval_term</A>| feature}
Switch on the |<A HREF="debugger.html#balloon-eval">balloon-eval</A>| functionality for the <A HREF="terminal.html#terminal">terminal</A>.
*<A NAME="'balloonexpr'"></A><B>'balloonexpr'</B>* *<A NAME="'bexpr'"></A><B>'bexpr'</B>*
<A HREF="#'balloonexpr'">'balloonexpr'</A> <A HREF="#'bexpr'">'bexpr'</A> <A HREF="eval.html#string">string</A> (default "")
global or local to buffer |<A HREF="#global-local">global-local</A>|
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+balloon_eval">+balloon_eval</A>|
feature}
Expression for text to show in evaluation balloon. It is only used
when <A HREF="#'ballooneval'">'ballooneval'</A> is on. These <A HREF="eval.html#variables">variables</A> can be used:
<A HREF="eval.html#v:beval_bufnr">v:beval_bufnr</A> number of the buffer in which balloon is going to show
<A HREF="eval.html#v:beval_winnr">v:beval_winnr</A> number of the <A HREF="windows.html#window">window</A>
<A HREF="eval.html#v:beval_winid">v:beval_winid</A> ID of the <A HREF="windows.html#window">window</A>
<A HREF="eval.html#v:beval_lnum">v:beval_lnum</A> line number
<A HREF="eval.html#v:beval_col">v:beval_col</A> column number (byte index)
<A HREF="eval.html#v:beval_text">v:beval_text</A> <A HREF="motion.html#word">word</A> under or after the mouse pointer
The evaluation of the <A HREF="eval.html#expression">expression</A> must not have side effects!
Example:
<B> function! MyBalloonExpr()</B>
<B> return 'Cursor is at line ' . v:beval_lnum .</B>
<B> \', column ' . v:beval_col .</B>
<B> \ ' of file ' . bufname(v:beval_bufnr) .</B>
<B> \ ' on word "' . v:beval_text . '"'</B>
<B> endfunction</B>
<B> set bexpr=MyBalloonExpr()</B>
<B> set ballooneval</B>
Also see |<A HREF="eval.html#balloon_show()">balloon_show()</A>|, can be used if the content of the balloon
is to be fetched asynchronously.
NOTE: The balloon is displayed only if the cursor is on a text
character. If the result of evaluating <A HREF="#'balloonexpr'">'balloonexpr'</A> is not empty,
Vim does not try to send a message to an external debugger (Netbeans
or Sun Workshop).
The <A HREF="eval.html#expression">expression</A> will be evaluated in the |<A HREF="eval.html#sandbox">sandbox</A>| when set from a
<A HREF="#modeline">modeline</A>, see |<A HREF="eval.html#sandbox-option">sandbox-option</A>|.
It is not allowed to change text or jump to another <A HREF="windows.html#window">window</A> while
evaluating <A HREF="#'balloonexpr'">'balloonexpr'</A> |<A HREF="eval.html#textlock">textlock</A>|.
To check whether line breaks in the balloon text work use this check:
<B> if has("balloon_multiline")</B>
When they are supported "\n" characters will start a new line. If the
<A HREF="eval.html#expression">expression</A> evaluates to a |<A HREF="eval.html#List">List</A>| this is equal to using each List item
<A HREF="motion.html#as">as</A> a <A HREF="eval.html#string">string</A> and putting "\n" in between them.
NOTE: This option is set to "" when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'belloff'"></A><B>'belloff'</B>* *<A NAME="'bo'"></A><B>'bo'</B>*
<A HREF="#'belloff'">'belloff'</A> <A HREF="#'bo'">'bo'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not in Vi}
Specifies for which events the bell will not be rung. It is a comma
separated <A HREF="eval.html#list">list</A> of items. For each item that is present, the bell
will be silenced. This is most useful to specify specific events in
insert mode to be silenced.
<B><FONT COLOR="PURPLE"> item meaning when present </FONT></B>
all All events.
backspace When hitting <A HREF="motion.html#<BS>"><BS></A> or <A HREF="change.html#<Del>"><Del></A> and <A HREF="change.html#deleting">deleting</A> results in an
error.
cursor Fail to move around using the cursor keys or
<PageUp>/<PageDown> in |<A HREF="insert.html#Insert-mode">Insert-mode</A>|.
complete Error occurred when using |<A HREF="insert.html#i_CTRL-X_CTRL-K">i_CTRL-X_CTRL-K</A>| or
|<A HREF="insert.html#i_CTRL-X_CTRL-T">i_CTRL-X_CTRL-T</A>|.
copy Cannot copy char from insert mode using |<A HREF="insert.html#i_CTRL-Y">i_CTRL-Y</A>| or
|<A HREF="insert.html#i_CTRL-E">i_CTRL-E</A>|.
ctrlg Unknown Char after <C-G> in <A HREF="insert.html#Insert">Insert</A> mode.
error Other Error occurred (e.g. try to join last line)
(mostly used in |<A HREF="intro.html#Normal-mode">Normal-mode</A>| or |<A HREF="cmdline.html#Cmdline-mode">Cmdline-mode</A>|).
esc hitting <A HREF="intro.html#<Esc>"><Esc></A> in |<A HREF="intro.html#Normal-mode">Normal-mode</A>|.
<A HREF="starting.html#ex">ex</A> In |<A HREF="visual.html#Visual-mode">Visual-mode</A>|, hitting |<A HREF="intro.html#Q">Q</A>| results in an error.
<A HREF="hangulin.html#hangul">hangul</A> Error occurred when using <A HREF="hangulin.html#hangul">hangul</A> input.
insertmode Pressing <A HREF="intro.html#<Esc>"><Esc></A> in <A HREF="#'insertmode'">'insertmode'</A>.
lang Calling the beep module for Lua/Mzscheme/TCL.
mess No output available for |<A HREF="message.html#g<">g<</A>|.
showmatch Error occurred for <A HREF="#'showmatch'">'showmatch'</A> function.
<A HREF="motion.html#operator">operator</A> Empty region error |<A HREF="#cpo-E">cpo-E</A>|.
<A HREF="sponsor.html#register">register</A> Unknown <A HREF="sponsor.html#register">register</A> after <C-R> in |<A HREF="insert.html#Insert-mode">Insert-mode</A>|.
shell Bell from shell output |<A HREF="various.html#:!">:!</A>|.
<A HREF="spell.html#spell">spell</A> Error happened on <A HREF="spell.html#spell">spell</A> suggest.
wildmode More matches in |<A HREF="cmdline.html#cmdline-completion">cmdline-completion</A>| available
(depends on the <A HREF="#'wildmode'">'wildmode'</A> setting).
This is most useful to fine tune when in <A HREF="insert.html#Insert">Insert</A> mode the bell should
be rung. For <A HREF="intro.html#Normal">Normal</A> mode and <A HREF="intro.html#Ex">Ex</A> commands, the bell is often rung to
indicate that an error occurred. It can be silenced by adding the
"error" keyword.
*<A NAME="'binary'"></A><B>'binary'</B>* *<A NAME="'bin'"></A><B>'bin'</B>* *<A NAME="'nobinary'"></A><B>'nobinary'</B>* *<A NAME="'nobin'"></A><B>'nobin'</B>*
<A HREF="#'binary'">'binary'</A> <A HREF="#'bin'">'bin'</A> <A HREF="#boolean">boolean</A> (default off)
local to buffer
{not in Vi}
This option should be set before editing a binary file. You can also
use the |<A HREF="starting.html#-b">-b</A>| Vim argument. When this option is switched on a few
<A HREF="#options">options</A> will be changed (also when <A HREF="motion.html#it">it</A> already was on):
<A HREF="#'textwidth'">'textwidth'</A> will be set to 0
<A HREF="#'wrapmargin'">'wrapmargin'</A> will be set to 0
<A HREF="#'modeline'">'modeline'</A> will be off
<A HREF="#'expandtab'">'expandtab'</A> will be off
Also, <A HREF="#'fileformat'">'fileformat'</A> and <A HREF="#'fileformats'">'fileformats'</A> <A HREF="#options">options</A> will not be used, the
file is read and written like <A HREF="#'fileformat'">'fileformat'</A> was "<A HREF="os_unix.html#unix">unix</A>" (a single <A HREF="motion.html#<NL>"><NL></A>
separates lines).
The <A HREF="#'fileencoding'">'fileencoding'</A> and <A HREF="#'fileencodings'">'fileencodings'</A> <A HREF="#options">options</A> will not be used, the
file is read without conversion.
NOTE: When you start editing a(nother) file while the <A HREF="#'bin'">'bin'</A> option is
on, settings from autocommands may change the settings again (e.g.,
'textwidth'), causing trouble when editing. You might want to set
<A HREF="#'bin'">'bin'</A> again when the file has been loaded.
The previous values of these <A HREF="#options">options</A> are remembered and restored when
<A HREF="#'bin'">'bin'</A> is switched from on to off. Each buffer has its own set of
saved option values.
To edit a file with <A HREF="#'binary'">'binary'</A> set you can use the |<A HREF="editing.html#++bin">++bin</A>| argument.
This avoids you have to <A HREF="diff.html#do">do</A> "<A HREF="#:set">:set</A> <A HREF="#'bin'">bin</A>" which would have effect for all
files you edit.
When <A HREF="editing.html#writing">writing</A> a file the <A HREF="intro.html#<EOL>"><EOL></A> for the last line is only written if
there was one in the original file (normally Vim appends an <A HREF="intro.html#<EOL>"><EOL></A> to
the last line if there is none; this would make the file longer). See
the <A HREF="#'endofline'">'endofline'</A> option.
*<A NAME="'bioskey'"></A><B>'bioskey'</B>* *<A NAME="'biosk'"></A><B>'biosk'</B>* *<A NAME="'nobioskey'"></A><B>'nobioskey'</B>* *<A NAME="'nobiosk'"></A><B>'nobiosk'</B>*
<A HREF="#'bioskey'">'bioskey'</A> <A HREF="#'biosk'">'biosk'</A> <A HREF="#boolean">boolean</A> (default on)
global
{not in Vi} {only for MS-DOS}
This was for <A HREF="os_msdos.html#MS-DOS">MS-DOS</A> and is no longer supported.
*<A NAME="'bomb'"></A><B>'bomb'</B>* *<A NAME="'nobomb'"></A><B>'nobomb'</B>*
<A HREF="#'bomb'">'bomb'</A> <A HREF="#boolean">boolean</A> (default off)
local to buffer
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+multi_byte">+multi_byte</A>|
feature}
When <A HREF="editing.html#writing">writing</A> a file and the following conditions are met, a BOM (Byte
Order <A HREF="motion.html#Mark">Mark</A>) is prepended to the file:
- this option is on
- the <A HREF="#'binary'">'binary'</A> option is off
- <A HREF="#'fileencoding'">'fileencoding'</A> is "<A HREF="mbyte.html#utf-8">utf-8</A>", "ucs-2", "ucs-4" or one of the little/big
endian variants.
Some applications use the BOM to recognize the encoding of the file.
Often used for UCS-2 files on <A HREF="os_win32.html#MS-Windows">MS-Windows</A>. For other applications <A HREF="motion.html#it">it</A>
causes trouble, for example: "cat file1 file2" makes the BOM of file2
appear halfway the resulting file. Gcc doesn't accept a BOM.
When Vim reads a file and <A HREF="#'fileencodings'">'fileencodings'</A> starts with "ucs-bom", a
check for the presence of the BOM is done and <A HREF="#'bomb'">'bomb'</A> set accordingly.
Unless <A HREF="#'binary'">'binary'</A> is set, <A HREF="motion.html#it">it</A> is removed from the first line, so that you
don't see <A HREF="motion.html#it">it</A> when editing. When you don't change the <A HREF="#options">options</A>, the BOM
will be restored when <A HREF="editing.html#writing">writing</A> the file.
*<A NAME="'breakat'"></A><B>'breakat'</B>* *<A NAME="'brk'"></A><B>'brk'</B>*
<A HREF="#'breakat'">'breakat'</A> <A HREF="#'brk'">'brk'</A> <A HREF="eval.html#string">string</A> (default " ^I!@*-+;:,./?")
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+linebreak">+linebreak</A>|
feature}
This option lets you choose which characters might cause a line
break if <A HREF="#'linebreak'">'linebreak'</A> is on. Only works for ASCII and also for 8-bit
characters when <A HREF="#'encoding'">'encoding'</A> is an 8-bit encoding.
*<A NAME="'breakindent'"></A><B>'breakindent'</B>* *<A NAME="'bri'"></A><B>'bri'</B>* *<A NAME="'nobreakindent'"></A><B>'nobreakindent'</B>* *<A NAME="'nobri'"></A><B>'nobri'</B>*
<A HREF="#'breakindent'">'breakindent'</A> <A HREF="#'bri'">'bri'</A> <A HREF="#boolean">boolean</A> (default off)
local to <A HREF="windows.html#window">window</A>
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+linebreak">+linebreak</A>|
feature}
Every wrapped line will continue visually indented (same amount of
space <A HREF="motion.html#as">as</A> the beginning of that line), thus preserving horizontal blocks
of text.
NOTE: This option is reset when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'breakindentopt'"></A><B>'breakindentopt'</B>* *<A NAME="'briopt'"></A><B>'briopt'</B>*
<A HREF="#'breakindentopt'">'breakindentopt'</A> <A HREF="#'briopt'">'briopt'</A> <A HREF="eval.html#string">string</A> (default empty)
local to <A HREF="windows.html#window">window</A>
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+linebreak">+linebreak</A>|
feature}
Settings for <A HREF="#'breakindent'">'breakindent'</A>. It can consist of the following optional
items and must be separated by a comma:
min:{n} Minimum text width that will be kept after
applying <A HREF="#'breakindent'">'breakindent'</A>, even if the resulting
text should normally be narrower. This prevents
text indented almost to the right <A HREF="windows.html#window">window</A> border
occupying lot of vertical space when broken.
shift:{n} After applying <A HREF="#'breakindent'">'breakindent'</A>, the wrapped line's
beginning will be shifted by the given number of
characters. It permits dynamic French <A HREF="motion.html#paragraph">paragraph</A>
indentation (negative) or emphasizing the line
continuation (positive).
sbr Display the <A HREF="#'showbreak'">'showbreak'</A> value before applying the
additional indent.
The default value for min is 20 and <A HREF="intro.html#shift">shift</A> is 0.
*<A NAME="'browsedir'"></A><B>'browsedir'</B>* *<A NAME="'bsdir'"></A><B>'bsdir'</B>*
<A HREF="#'browsedir'">'browsedir'</A> <A HREF="#'bsdir'">'bsdir'</A> <A HREF="eval.html#string">string</A> (default: "last")
global
{not in Vi} {only for <A HREF="gui_x11.html#Motif">Motif</A>, <A HREF="gui_x11.html#Athena">Athena</A>, <A HREF="gui_x11.html#GTK">GTK</A>, <A HREF="os_mac.html#Mac">Mac</A> and
<A HREF="os_win32.html#Win32">Win32</A> GUI}
Which directory to use for the file browser:
last Use same directory <A HREF="motion.html#as">as</A> with last file browser, where a
file was opened or saved.
buffer Use the directory of the related buffer.
current Use the current directory.
{path} Use the specified directory
*<A NAME="'bufhidden'"></A><B>'bufhidden'</B>* *<A NAME="'bh'"></A><B>'bh'</B>*
<A HREF="#'bufhidden'">'bufhidden'</A> <A HREF="#'bh'">'bh'</A> <A HREF="eval.html#string">string</A> (default: "")
local to buffer
{not in Vi}
This option specifies what happens when a buffer is no longer
displayed in a <A HREF="windows.html#window">window</A>:
<empty> follow the global <A HREF="#'hidden'">'hidden'</A> option
hide hide the buffer (don't unload it), also when <A HREF="#'hidden'">'hidden'</A>
is not set
unload unload the buffer, also when <A HREF="#'hidden'">'hidden'</A> is set or using
|<A HREF="windows.html#:hide">:hide</A>|
delete delete the buffer from the buffer <A HREF="eval.html#list">list</A>, also when
<A HREF="#'hidden'">'hidden'</A> is set or using |<A HREF="windows.html#:hide">:hide</A>|, like using
|<A HREF="windows.html#:bdelete">:bdelete</A>|
wipe wipe out the buffer from the buffer <A HREF="eval.html#list">list</A>, also when
<A HREF="#'hidden'">'hidden'</A> is set or using |<A HREF="windows.html#:hide">:hide</A>|, like using
|<A HREF="windows.html#:bwipeout">:bwipeout</A>|
CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
are lost without a warning. Also, these values may break autocommands
that switch between <A HREF="windows.html#buffers">buffers</A> temporarily.
This option is used together with <A HREF="#'buftype'">'buftype'</A> and <A HREF="#'swapfile'">'swapfile'</A> to specify
special kinds of buffers. See |<A HREF="windows.html#special-buffers">special-buffers</A>|.
*<A NAME="'buflisted'"></A><B>'buflisted'</B>* *<A NAME="'bl'"></A><B>'bl'</B>* *<A NAME="'nobuflisted'"></A><B>'nobuflisted'</B>* *<A NAME="'nobl'"></A><B>'nobl'</B>* *<A NAME="E85"></A><B>E85</B>*
<A HREF="#'buflisted'">'buflisted'</A> <A HREF="#'bl'">'bl'</A> <A HREF="#boolean">boolean</A> (default: on)
local to buffer
{not in Vi}
When this option is set, the buffer shows up in the buffer <A HREF="eval.html#list">list</A>. If
<A HREF="motion.html#it">it</A> is reset <A HREF="motion.html#it">it</A> is not used for "<A HREF="windows.html#:bnext">:bnext</A>", "ls", the Buffers menu, etc.
This option is reset by Vim for <A HREF="windows.html#buffers">buffers</A> that are only used to remember
a file name or marks. Vim sets <A HREF="motion.html#it">it</A> when starting to edit a buffer.
But not when moving to a buffer with "<A HREF="windows.html#:buffer">:buffer</A>".
*<A NAME="'buftype'"></A><B>'buftype'</B>* *<A NAME="'bt'"></A><B>'bt'</B>* *<A NAME="E382"></A><B>E382</B>*
<A HREF="#'buftype'">'buftype'</A> <A HREF="#'bt'">'bt'</A> <A HREF="eval.html#string">string</A> (default: "")
local to buffer
{not in Vi}
The value of this option specifies the type of a buffer:
<empty> normal buffer
nofile buffer which is not related to a file and will not be
written
nowrite buffer which will not be written
acwrite buffer which will always be written with <A HREF="autocmd.html#BufWriteCmd">BufWriteCmd</A>
autocommands. {not available when compiled without the
|<A HREF="various.html#+autocmd">+autocmd</A>| feature}
<A HREF="quickfix.html#quickfix">quickfix</A> <A HREF="quickfix.html#quickfix">quickfix</A> buffer, contains <A HREF="eval.html#list">list</A> of <A HREF="message.html#errors">errors</A> |<A HREF="quickfix.html#:cwindow">:cwindow</A>|
or <A HREF="eval.html#list">list</A> of locations |<A HREF="quickfix.html#:lwindow">:lwindow</A>|
help help buffer (you are not supposed to set this
manually)
terminal buffer for a |<A HREF="terminal.html#terminal">terminal</A>| (you are not supposed to set
this manually)
This option is used together with <A HREF="#'bufhidden'">'bufhidden'</A> and <A HREF="#'swapfile'">'swapfile'</A> to
specify special kinds of buffers. See |<A HREF="windows.html#special-buffers">special-buffers</A>|.
Be careful with <A HREF="change.html#changing">changing</A> this option, <A HREF="motion.html#it">it</A> can have many side effects!
A "<A HREF="quickfix.html#quickfix">quickfix</A>" buffer is only used for the error <A HREF="eval.html#list">list</A> and the location
<A HREF="eval.html#list">list</A>. This value is set by the |<A HREF="quickfix.html#:cwindow">:cwindow</A>| and |<A HREF="quickfix.html#:lwindow">:lwindow</A>| commands and
you are not supposed to change <A HREF="motion.html#it">it</A>.
"nofile" and "nowrite" <A HREF="windows.html#buffers">buffers</A> are similar:
both: The buffer is not to be written to disk, "<A HREF="editing.html#:w">:w</A>" doesn't
work (":w filename" does work though).
both: The buffer is never considered to be |<A HREF="#'modified'">'modified'</A>|.
There is no warning when the changes will be lost, for
example when you quit Vim.
both: A swap file is only created when using too much memory
(when <A HREF="#'swapfile'">'swapfile'</A> has been reset there is never a swap
file).
nofile only: The buffer name is fixed, <A HREF="motion.html#it">it</A> is not handled like a
file name. It is not modified in response to a |<A HREF="editing.html#:cd">:cd</A>|
command.
both: When using "<A HREF="editing.html#:e">:e</A> bufname" and already editing "bufname"
the buffer is made empty and autocommands are
triggered <A HREF="motion.html#as">as</A> usual for |<A HREF="editing.html#:edit">:edit</A>|.
*<A NAME="E676"></A><B>E676</B>*
"acwrite" implies that the buffer name is not related to a file, like
"nofile", but <A HREF="motion.html#it">it</A> will be written. Thus, in contrast to "nofile" and
"nowrite", "<A HREF="editing.html#:w">:w</A>" does work and a modified buffer can't be abandoned
without saving. For <A HREF="editing.html#writing">writing</A> there must be matching |<A HREF="autocmd.html#BufWriteCmd">BufWriteCmd</A>|,
|<A HREF="autocmd.html#FileWriteCmd">FileWriteCmd</A>| or |<A HREF="autocmd.html#FileAppendCmd">FileAppendCmd</A>| autocommands.
*<A NAME="'casemap'"></A><B>'casemap'</B>* *<A NAME="'cmp'"></A><B>'cmp'</B>*
<A HREF="#'casemap'">'casemap'</A> <A HREF="#'cmp'">'cmp'</A> <A HREF="eval.html#string">string</A> (default: "internal,keepascii")
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+multi_byte">+multi_byte</A>|
feature}
Specifies details about <A HREF="change.html#changing">changing</A> the <A HREF="change.html#case">case</A> of letters. It may contain
these words, separated by a comma:
internal Use internal <A HREF="change.html#case">case</A> <A HREF="map.html#mapping">mapping</A> <A HREF="eval.html#functions">functions</A>, the current
<A HREF="mbyte.html#locale">locale</A> does not change the <A HREF="change.html#case">case</A> <A HREF="map.html#mapping">mapping</A>. This only
matters when <A HREF="#'encoding'">'encoding'</A> is a <A HREF="mbyte.html#Unicode">Unicode</A> encoding,
"latin1" or "iso-8859-15". When "internal" is
omitted, the towupper() and towlower() system library
<A HREF="eval.html#functions">functions</A> are used when available.
keepascii For the ASCII characters (0x00 to 0x7f) use the US
<A HREF="change.html#case">case</A> <A HREF="map.html#mapping">mapping</A>, the current <A HREF="mbyte.html#locale">locale</A> is not effective.
This probably only matters for Turkish.
*<A NAME="'cdpath'"></A><B>'cdpath'</B>* *<A NAME="'cd'"></A><B>'cd'</B>* *<A NAME="E344"></A><B>E344</B>* *<A NAME="E346"></A><B>E346</B>*
<A HREF="#'cdpath'">'cdpath'</A> <A HREF="#'cd'">'cd'</A> <A HREF="eval.html#string">string</A> (default: equivalent to $CDPATH or ",,")
global
{not in Vi}
{not available when compiled without the
|<A HREF="various.html#+file_in_path">+file_in_path</A>| feature}
This is a <A HREF="eval.html#list">list</A> of directories which will be searched when using the
|<A HREF="editing.html#:cd">:cd</A>| and |<A HREF="editing.html#:lcd">:lcd</A>| commands, provided that the directory being searched
for has a relative path, not an absolute part starting with "<A HREF="pattern.html#/">/</A>", "./"
or "../", the <A HREF="#'cdpath'">'cdpath'</A> option is not used then.
The <A HREF="#'cdpath'">'cdpath'</A> option's value has the same form and semantics <A HREF="motion.html#as">as</A>
|<A HREF="#'path'">'path'</A>|. Also see |<A HREF="editing.html#file-searching">file-searching</A>|.
The default value is taken from $CDPATH, with a "<A HREF="motion.html#,">,</A>" prepended to look
in the current directory first.
If the default value taken from $CDPATH is not what you want, include
a modified version of the following command in your <A HREF="starting.html#vimrc">vimrc</A> file to
override <A HREF="motion.html#it">it</A>:
<B> :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')</B>
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
(parts of <A HREF="#'cdpath'">'cdpath'</A> can be passed to the shell to expand file names).
*<A NAME="'cedit'"></A><B>'cedit'</B>*
<A HREF="#'cedit'">'cedit'</A> <A HREF="eval.html#string">string</A> (Vi default: "", Vim default: <A HREF="scroll.html#CTRL-F">CTRL-F</A>)
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+vertsplit">+vertsplit</A>|
feature}
The key used in <A HREF="cmdline.html#Command-line">Command-line</A> Mode to open the command-line <A HREF="windows.html#window">window</A>.
The default is <A HREF="scroll.html#CTRL-F">CTRL-F</A> when <A HREF="#'compatible'">'compatible'</A> is off.
Only non-printable keys are allowed.
The key can be specified <A HREF="motion.html#as">as</A> a single character, but <A HREF="motion.html#it">it</A> is difficult to
type. The preferred way is to use the <A HREF="intro.html#<>"><></A> <A HREF="intro.html#notation">notation</A>. Examples:
<B> :exe "set cedit=\<C-Y>"</B>
<B> :exe "set cedit=\<Esc>"</B>
|<A HREF="intro.html#Nvi">Nvi</A>| also has this option, but <A HREF="motion.html#it">it</A> only uses the first character.
See |<A HREF="cmdline.html#cmdwin">cmdwin</A>|.
NOTE: This option is set to the Vim default value when <A HREF="#'compatible'">'compatible'</A>
is reset.
*<A NAME="'charconvert'"></A><B>'charconvert'</B>* *<A NAME="'ccv'"></A><B>'ccv'</B>* *<A NAME="E202"></A><B>E202</B>* *<A NAME="E214"></A><B>E214</B>* *<A NAME="E513"></A><B>E513</B>*
<A HREF="#'charconvert'">'charconvert'</A> <A HREF="#'ccv'">'ccv'</A> <A HREF="eval.html#string">string</A> (default "")
global
{only available when compiled with the |<A HREF="various.html#+multi_byte">+multi_byte</A>|
and |<A HREF="various.html#+eval">+eval</A>| features}
{not in Vi}
An <A HREF="eval.html#expression">expression</A> that is used for character encoding conversion. It is
evaluated when a file that is to be read or has been written has a
different encoding from what is desired.
<A HREF="#'charconvert'">'charconvert'</A> is not used when the internal <A HREF="eval.html#iconv()">iconv()</A> function is
supported and is able to <A HREF="diff.html#do">do</A> the conversion. Using <A HREF="eval.html#iconv()">iconv()</A> is
preferred, because <A HREF="motion.html#it">it</A> is much faster.
<A HREF="#'charconvert'">'charconvert'</A> is not used when reading stdin |<A HREF="starting.html#--">--</A>|, because there is no
file to convert from. You will have to save the text in a file first.
The <A HREF="eval.html#expression">expression</A> must return zero or an empty <A HREF="eval.html#string">string</A> for success,
non-zero for failure.
The possible encoding names encountered are in <A HREF="#'encoding'">'encoding'</A>.
Additionally, names given in <A HREF="#'fileencodings'">'fileencodings'</A> and <A HREF="#'fileencoding'">'fileencoding'</A> are
used.
Conversion between "latin1", "<A HREF="mbyte.html#unicode">unicode</A>", "ucs-2", "ucs-4" and "<A HREF="mbyte.html#utf-8">utf-8</A>"
is done internally by Vim, <A HREF="#'charconvert'">'charconvert'</A> is not used for this.
<A HREF="#'charconvert'">'charconvert'</A> is also used to convert the <A HREF="starting.html#viminfo">viminfo</A> file, if the '<A HREF="change.html#c">c</A>'
flag is present in <A HREF="#'viminfo'">'viminfo'</A>. Also used for <A HREF="mbyte.html#Unicode">Unicode</A> conversion.
Example:
<B> set charconvert=CharConvert()</B>
<B> fun CharConvert()</B>
<B> system("recode "</B>
<B> \ . v:charconvert_from . ".." . v:charconvert_to</B>
<B> \ . " <" . v:fname_in . " >" v:fname_out)</B>
<B> return v:shell_error</B>
<B> endfun</B>
The related Vim <A HREF="eval.html#variables">variables</A> are:
<A HREF="eval.html#v:charconvert_from">v:charconvert_from</A> name of the current encoding
<A HREF="eval.html#v:charconvert_to">v:charconvert_to</A> name of the desired encoding
<A HREF="eval.html#v:fname_in">v:fname_in</A> name of the input file
<A HREF="eval.html#v:fname_out">v:fname_out</A> name of the output file
Note that <A HREF="eval.html#v:fname_in">v:fname_in</A> and <A HREF="eval.html#v:fname_out">v:fname_out</A> will never be the same.
Note that <A HREF="eval.html#v:charconvert_from">v:charconvert_from</A> and <A HREF="eval.html#v:charconvert_to">v:charconvert_to</A> may be different
from <A HREF="#'encoding'">'encoding'</A>. Vim internally uses <A HREF="mbyte.html#UTF-8">UTF-8</A> instead of UCS-2 or UCS-4.
Encryption is not done by Vim when using <A HREF="#'charconvert'">'charconvert'</A>. If you want
to encrypt the file after conversion, <A HREF="#'charconvert'">'charconvert'</A> should take care
of this.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'cindent'"></A><B>'cindent'</B>* *<A NAME="'cin'"></A><B>'cin'</B>* *<A NAME="'nocindent'"></A><B>'nocindent'</B>* *<A NAME="'nocin'"></A><B>'nocin'</B>*
<A HREF="#'cindent'">'cindent'</A> <A HREF="#'cin'">'cin'</A> <A HREF="#boolean">boolean</A> (default off)
local to buffer
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+cindent">+cindent</A>|
feature}
Enables automatic C program indenting. See <A HREF="#'cinkeys'">'cinkeys'</A> to set the keys
that trigger reindenting in insert mode and <A HREF="#'cinoptions'">'cinoptions'</A> to set your
preferred indent style.
If <A HREF="#'indentexpr'">'indentexpr'</A> is not empty, <A HREF="motion.html#it">it</A> overrules <A HREF="#'cindent'">'cindent'</A>.
If <A HREF="#'lisp'">'lisp'</A> is not on and both <A HREF="#'indentexpr'">'indentexpr'</A> and <A HREF="#'equalprg'">'equalprg'</A> are empty,
the "<A HREF="change.html#=">=</A>" <A HREF="motion.html#operator">operator</A> indents using this algorithm rather than calling an
external program.
See |<A HREF="indent.html#C-indenting">C-indenting</A>|.
When you don't like the way <A HREF="#'cindent'">'cindent'</A> works, try the <A HREF="#'smartindent'">'smartindent'</A>
option or <A HREF="#'indentexpr'">'indentexpr'</A>.
This option is not used when <A HREF="#'paste'">'paste'</A> is set.
NOTE: This option is reset when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'cinkeys'"></A><B>'cinkeys'</B>* *<A NAME="'cink'"></A><B>'cink'</B>*
<A HREF="#'cinkeys'">'cinkeys'</A> <A HREF="#'cink'">'cink'</A> <A HREF="eval.html#string">string</A> (default "0{,0},0),:,0#,!^F,o,O,e")
local to buffer
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+cindent">+cindent</A>|
feature}
A <A HREF="eval.html#list">list</A> of keys that, when typed in <A HREF="insert.html#Insert">Insert</A> mode, cause reindenting of
the current line. Only used if <A HREF="#'cindent'">'cindent'</A> is on and <A HREF="#'indentexpr'">'indentexpr'</A> is
empty.
For the format of this option see |<A HREF="indent.html#cinkeys-format">cinkeys-format</A>|.
See |<A HREF="indent.html#C-indenting">C-indenting</A>|.
*<A NAME="'cinoptions'"></A><B>'cinoptions'</B>* *<A NAME="'cino'"></A><B>'cino'</B>*
<A HREF="#'cinoptions'">'cinoptions'</A> <A HREF="#'cino'">'cino'</A> <A HREF="eval.html#string">string</A> (default "")
local to buffer
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+cindent">+cindent</A>|
feature}
The <A HREF="#'cinoptions'">'cinoptions'</A> affect the way <A HREF="#'cindent'">'cindent'</A> reindents lines in a C
program. See |<A HREF="indent.html#cinoptions-values">cinoptions-values</A>| for the values of this option, and
|<A HREF="indent.html#C-indenting">C-indenting</A>| for info on C indenting in general.
*<A NAME="'cinwords'"></A><B>'cinwords'</B>* *<A NAME="'cinw'"></A><B>'cinw'</B>*
<A HREF="#'cinwords'">'cinwords'</A> <A HREF="#'cinw'">'cinw'</A> <A HREF="eval.html#string">string</A> (default "if,else,while,do,for,switch")
local to buffer
{not in Vi}
{not available when compiled without both the
|<A HREF="various.html#+cindent">+cindent</A>| and the |<A HREF="various.html#+smartindent">+smartindent</A>| features}
These keywords start an extra indent in the next line when
<A HREF="#'smartindent'">'smartindent'</A> or <A HREF="#'cindent'">'cindent'</A> is set. For <A HREF="#'cindent'">'cindent'</A> this is only done at
an appropriate place (inside <A HREF="intro.html#{}">{}</A>).
Note that <A HREF="#'ignorecase'">'ignorecase'</A> isn't used for <A HREF="#'cinwords'">'cinwords'</A>. If <A HREF="change.html#case">case</A> doesn't
matter, include the keyword both the <A HREF="change.html#uppercase">uppercase</A> and <A HREF="change.html#lowercase">lowercase</A>:
"if,If,IF".
*<A NAME="'clipboard'"></A><B>'clipboard'</B>* *<A NAME="'cb'"></A><B>'cb'</B>*
<A HREF="#'clipboard'">'clipboard'</A> <A HREF="#'cb'">'cb'</A> <A HREF="eval.html#string">string</A> (default "autoselect,exclude:cons\|linux"
for X-windows, "" otherwise)
global
{not in Vi}
{only in <A HREF="gui.html#GUI">GUI</A> versions or when the |<A HREF="various.html#+xterm_clipboard">+xterm_clipboard</A>|
feature is included}
This option is a <A HREF="eval.html#list">list</A> of comma separated names.
These names are recognized:
*<A NAME="clipboard-unnamed"></A><B>clipboard-unnamed</B>*
unnamed When included, Vim will use the <A HREF="gui.html#clipboard">clipboard</A> <A HREF="sponsor.html#register">register</A> '*'
for all <A HREF="change.html#yank">yank</A>, delete, change and put operations which
would normally go to the unnamed <A HREF="sponsor.html#register">register</A>. When a
<A HREF="sponsor.html#register">register</A> is explicitly specified, <A HREF="motion.html#it">it</A> will always be
used regardless of whether "unnamed" is in <A HREF="#'clipboard'">'clipboard'</A>
or not. The <A HREF="gui.html#clipboard">clipboard</A> <A HREF="sponsor.html#register">register</A> can always be
explicitly accessed using the "* <A HREF="intro.html#notation">notation</A>. Also see
|<A HREF="gui_w32.html#gui-clipboard">gui-clipboard</A>|.
*<A NAME="clipboard-unnamedplus"></A><B>clipboard-unnamedplus</B>*
unnamedplus A variant of the "unnamed" flag which uses the
<A HREF="gui.html#clipboard">clipboard</A> <A HREF="sponsor.html#register">register</A> '<A HREF="motion.html#+">+</A>' (|<A HREF="gui_x11.html#quoteplus">quoteplus</A>|) instead of
<A HREF="sponsor.html#register">register</A> '*' for all <A HREF="change.html#yank">yank</A>, delete, change and put
operations which would normally go to the unnamed
<A HREF="sponsor.html#register">register</A>. When "unnamed" is also included to the
option, <A HREF="change.html#yank">yank</A> operations (but not delete, change or
put) will additionally copy the text into <A HREF="sponsor.html#register">register</A>
'*'.
Only available with the |<A HREF="various.html#+X11">+X11</A>| feature.
Availability can be checked with:
<B> if has('unnamedplus')</B>
*<A NAME="clipboard-autoselect"></A><B>clipboard-autoselect</B>*
autoselect Works like the '<A HREF="insert.html#a">a</A>' flag in <A HREF="#'guioptions'">'guioptions'</A>: If present,
then whenever <A HREF="visual.html#Visual">Visual</A> mode is started, or the <A HREF="visual.html#Visual">Visual</A>
area extended, Vim tries to become the owner of the
windowing system's global selection or put the
selected text on the <A HREF="gui.html#clipboard">clipboard</A> used by the selection
<A HREF="sponsor.html#register">register</A> "*. See |<A HREF="#guioptions_a">guioptions_a</A>| and |<A HREF="gui.html#quotestar">quotestar</A>| for
details. When the <A HREF="gui.html#GUI">GUI</A> is active, the '<A HREF="insert.html#a">a</A>' flag in
<A HREF="#'guioptions'">'guioptions'</A> is used, when the <A HREF="gui.html#GUI">GUI</A> is not active, this
"autoselect" flag is used.
Also applies to the modeless selection.
*<A NAME="clipboard-autoselectplus"></A><B>clipboard-autoselectplus</B>*
autoselectplus Like "autoselect" but using the + <A HREF="sponsor.html#register">register</A> instead of
the * <A HREF="sponsor.html#register">register</A>. Compare to the '<A HREF="change.html#P">P</A>' flag in
<A HREF="#'guioptions'">'guioptions'</A>.
*<A NAME="clipboard-autoselectml"></A><B>clipboard-autoselectml</B>*
autoselectml Like "autoselect", but for the modeless selection
only. Compare to the '<A HREF="insert.html#A">A</A>' flag in <A HREF="#'guioptions'">'guioptions'</A>.
*<A NAME="clipboard-html"></A><B>clipboard-html</B>*
html When the <A HREF="gui.html#clipboard">clipboard</A> contains HTML, use this when
pasting. When putting text on the <A HREF="gui.html#clipboard">clipboard</A>, <A HREF="motion.html#mark">mark</A> <A HREF="motion.html#it">it</A>
<A HREF="motion.html#as">as</A> HTML. This works to copy rendered HTML from
Firefox, paste <A HREF="motion.html#it">it</A> <A HREF="motion.html#as">as</A> raw HTML in Vim, select the HTML
in Vim and paste <A HREF="motion.html#it">it</A> in a rich edit box in Firefox.
You probably want to add this only temporarily,
possibly use <A HREF="autocmd.html#BufEnter">BufEnter</A> autocommands.
Only supported for <A HREF="gui_x11.html#GTK">GTK</A> version 2 and later.
Only available with the |<A HREF="various.html#+multi_byte">+multi_byte</A>| feature.
*<A NAME="clipboard-exclude"></A><B>clipboard-exclude</B>*
exclude:{pattern}
Defines a <A HREF="pattern.html#pattern">pattern</A> that is matched against the name of
the <A HREF="terminal.html#terminal">terminal</A> <A HREF="#'term'">'term'</A>. If there is a match, no
connection will be made to the X server. This is
useful in this situation:
- Running Vim in a console.
- $DISPLAY is set to start applications on another
display.
- You <A HREF="diff.html#do">do</A> not want to connect to the X server in the
console, but <A HREF="diff.html#do">do</A> want this in a <A HREF="terminal.html#terminal">terminal</A> emulator.
To never connect to the X server use:
<B> exclude:.*</B>
This has the same effect <A HREF="motion.html#as">as</A> using the |<A HREF="starting.html#-X">-X</A>| argument.
Note that when there is no connection to the X server
the <A HREF="windows.html#window">window</A> title won't be restored and the <A HREF="gui.html#clipboard">clipboard</A>
cannot be accessed.
The value of <A HREF="#'magic'">'magic'</A> is ignored, {pattern} is
interpreted <A HREF="motion.html#as">as</A> if <A HREF="#'magic'">'magic'</A> was on.
The rest of the option value will be used for
{pattern}, this must be the last entry.
*<A NAME="'cmdheight'"></A><B>'cmdheight'</B>* *<A NAME="'ch'"></A><B>'ch'</B>*
<A HREF="#'cmdheight'">'cmdheight'</A> <A HREF="#'ch'">'ch'</A> number (default 1)
global
{not in Vi}
<A HREF="eval.html#Number">Number</A> of screen lines to use for the command-line. Helps avoiding
|<A HREF="message.html#hit-enter">hit-enter</A>| prompts.
The value of this option is stored with the <A HREF="intro.html#tab">tab</A> page, so that each <A HREF="intro.html#tab">tab</A>
page can have a different value.
*<A NAME="'cmdwinheight'"></A><B>'cmdwinheight'</B>* *<A NAME="'cwh'"></A><B>'cwh'</B>*
<A HREF="#'cmdwinheight'">'cmdwinheight'</A> <A HREF="#'cwh'">'cwh'</A> number (default 7)
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+vertsplit">+vertsplit</A>|
feature}
<A HREF="eval.html#Number">Number</A> of screen lines to use for the command-line <A HREF="windows.html#window">window</A>. |<A HREF="cmdline.html#cmdwin">cmdwin</A>|
*<A NAME="'colorcolumn'"></A><B>'colorcolumn'</B>* *<A NAME="'cc'"></A><B>'cc'</B>*
<A HREF="#'colorcolumn'">'colorcolumn'</A> <A HREF="#'cc'">'cc'</A> <A HREF="eval.html#string">string</A> (default "")
local to <A HREF="windows.html#window">window</A>
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+syntax">+syntax</A>|
feature}
<A HREF="#'colorcolumn'">'colorcolumn'</A> is a comma separated <A HREF="eval.html#list">list</A> of screen columns that are
highlighted with ColorColumn |<A HREF="syntax.html#hl-ColorColumn">hl-ColorColumn</A>|. Useful to align
text. Will make screen redrawing slower.
The screen column can be an absolute number, or a number preceded with
'<A HREF="motion.html#+">+</A>' or '<A HREF="motion.html#-">-</A>', which is added to or subtracted from <A HREF="#'textwidth'">'textwidth'</A>.
<B> :set cc=+1 " highlight column after 'textwidth'</B>
<B> :set cc=+1,+2,+3 " highlight three columns after 'textwidth'</B>
<B> :hi ColorColumn ctermbg=lightgrey guibg=lightgrey</B>
When <A HREF="#'textwidth'">'textwidth'</A> is zero then the items with '<A HREF="motion.html#-">-</A>' and '<A HREF="motion.html#+">+</A>' are not used.
A maximum of 256 columns are highlighted.
*<A NAME="'columns'"></A><B>'columns'</B>* *<A NAME="'co'"></A><B>'co'</B>* *<A NAME="E594"></A><B>E594</B>*
<A HREF="#'columns'">'columns'</A> <A HREF="#'co'">'co'</A> number (default 80 or <A HREF="terminal.html#terminal">terminal</A> width)
global
{not in Vi}
<A HREF="eval.html#Number">Number</A> of columns of the screen. Normally this is set by the <A HREF="terminal.html#terminal">terminal</A>
<A HREF="starting.html#initialization">initialization</A> and does not have to be set by hand. Also see
|<A HREF="vi_diff.html#posix-screen-size">posix-screen-size</A>|.
When Vim is running in the <A HREF="gui.html#GUI">GUI</A> or in a resizable <A HREF="windows.html#window">window</A>, setting this
option will cause the <A HREF="windows.html#window">window</A> size to be changed. When you only want
to use the size for the <A HREF="gui.html#GUI">GUI</A>, put the command in your |<A HREF="gui.html#gvimrc">gvimrc</A>| file.
When you set this option and Vim is unable to change the physical
number of columns of the display, the display may be messed up. For
the <A HREF="gui.html#GUI">GUI</A> <A HREF="motion.html#it">it</A> is always possible and Vim <A HREF="vi_diff.html#limits">limits</A> the number of columns to
what fits on the screen. You can use this command to get the widest
<A HREF="windows.html#window">window</A> possible:
<B> :set columns=9999</B>
Minimum value is 12, maximum value is 10000.
*<A NAME="'comments'"></A><B>'comments'</B>* *<A NAME="'com'"></A><B>'com'</B>* *<A NAME="E524"></A><B>E524</B>* *<A NAME="E525"></A><B>E525</B>*
<A HREF="#'comments'">'comments'</A> <A HREF="#'com'">'com'</A> <A HREF="eval.html#string">string</A> (default
"s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
local to buffer
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+comments">+comments</A>|
feature}
A comma separated <A HREF="eval.html#list">list</A> of strings that can start a comment line. See
|<A HREF="change.html#format-comments">format-comments</A>|. See |<A HREF="#option-backslash">option-backslash</A>| about using backslashes to
insert a space.
*<A NAME="'commentstring'"></A><B>'commentstring'</B>* *<A NAME="'cms'"></A><B>'cms'</B>* *<A NAME="E537"></A><B>E537</B>*
<A HREF="#'commentstring'">'commentstring'</A> <A HREF="#'cms'">'cms'</A> <A HREF="eval.html#string">string</A> (default "/*%s*/")
local to buffer
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+folding">+folding</A>|
feature}
A <A HREF="autocmd.html#template">template</A> for a comment. The "%s" in the value is replaced with the
comment text. Currently only used to add markers for <A HREF="fold.html#folding">folding</A>, see
|<A HREF="fold.html#fold-marker">fold-marker</A>|.
*<A NAME="'compatible'"></A><B>'compatible'</B>* *<A NAME="'cp'"></A><B>'cp'</B>* *<A NAME="'nocompatible'"></A><B>'nocompatible'</B>* *<A NAME="'nocp'"></A><B>'nocp'</B>*
<A HREF="#'compatible'">'compatible'</A> <A HREF="#'cp'">'cp'</A> <A HREF="#boolean">boolean</A> (default on, off when a |<A HREF="starting.html#vimrc">vimrc</A>| or |<A HREF="gui.html#gvimrc">gvimrc</A>|
file is found, reset in |<A HREF="defaults.html">defaults.vim</A>|)
global
{not in Vi}
This option has the effect of making Vim either more Vi-compatible, or
make Vim behave in a more useful way.
This is a special kind of option, because when it's set or reset,
other <A HREF="#options">options</A> are also changed <A HREF="motion.html#as">as</A> a side effect.
NOTE: Setting or resetting this option can have a lot of unexpected
effects: Mappings are interpreted in another way, <A HREF="undo.html#undo">undo</A> behaves
differently, etc. If you set this option in your <A HREF="starting.html#vimrc">vimrc</A> file, you
should probably put <A HREF="motion.html#it">it</A> at the very start.
By default this option is on and the <A HREF="intro.html#Vi">Vi</A> defaults are used for the
<A HREF="#options">options</A>. This default was chosen for those people who want to use Vim
just like <A HREF="intro.html#Vi">Vi</A>, and don't even (want to) know about the <A HREF="#'compatible'">'compatible'</A>
option.
When a |<A HREF="starting.html#vimrc">vimrc</A>| or |<A HREF="gui.html#gvimrc">gvimrc</A>| file is found while Vim is starting up,
this option is switched off, and all <A HREF="#options">options</A> that have not been
modified will be set to the Vim defaults. Effectively, this means
that when a |<A HREF="starting.html#vimrc">vimrc</A>| or |<A HREF="gui.html#gvimrc">gvimrc</A>| file exists, Vim will use the Vim
defaults, otherwise <A HREF="motion.html#it">it</A> will use the <A HREF="intro.html#Vi">Vi</A> defaults. (Note: This doesn't
happen for the system-wide <A HREF="starting.html#vimrc">vimrc</A> or <A HREF="gui.html#gvimrc">gvimrc</A> file, nor for a file given
with the |<A HREF="starting.html#-u">-u</A>| argument). Also see |<A HREF="starting.html#compatible-default">compatible-default</A>| and
|<A HREF="vi_diff.html#posix-compliance">posix-compliance</A>|.
You can also set this option with the "<A HREF="starting.html#-C">-C</A>" argument, and reset <A HREF="motion.html#it">it</A> with
"-N". See |<A HREF="starting.html#-C">-C</A>| and |<A HREF="starting.html#-N">-N</A>|.
See <A HREF="#'cpoptions'">'cpoptions'</A> for more fine tuning of <A HREF="intro.html#Vi">Vi</A> compatibility.
When this option is set, numerous other <A HREF="#options">options</A> are set to make Vim <A HREF="motion.html#as">as</A>
Vi-compatible <A HREF="motion.html#as">as</A> possible. When this option is unset, various <A HREF="#options">options</A>
are set to make Vim more useful. The table below lists all the
<A HREF="#options">options</A> affected.
The {?} column indicates when the <A HREF="#options">options</A> are affected:
+ Means that the option is set to the value given in {set value} when
<A HREF="#'compatible'">'compatible'</A> is set.
<A HREF="change.html#&">&</A> Means that the option is set to the value given in {set value} when
<A HREF="#'compatible'">'compatible'</A> is set AND is set to its Vim default value when
<A HREF="#'compatible'">'compatible'</A> is unset.
- Means the option is NOT changed when setting <A HREF="#'compatible'">'compatible'</A> but IS
set to its Vim default when <A HREF="#'compatible'">'compatible'</A> is unset.
The {effect} column summarises the change when <A HREF="#'compatible'">'compatible'</A> is set.
<B><FONT COLOR="PURPLE"> option ? set value effect </FONT></B>
<A HREF="#'allowrevins'">'allowrevins'</A> + off no CTRL-_ command
<A HREF="#'antialias'">'antialias'</A> + off don't use antialiased fonts
<A HREF="#'arabic'">'arabic'</A> + off reset arabic-related <A HREF="#options">options</A>
<A HREF="#'arabicshape'">'arabicshape'</A> + on correct character shapes
<A HREF="#'backspace'">'backspace'</A> + "" normal backspace
<A HREF="#'backup'">'backup'</A> + off no <A HREF="editing.html#backup">backup</A> file
<A HREF="#'backupcopy'">'backupcopy'</A> <A HREF="change.html#&">&</A> <A HREF="os_unix.html#Unix">Unix</A>: "yes" <A HREF="editing.html#backup">backup</A> file is a copy
else: "auto" copy or rename <A HREF="editing.html#backup">backup</A> file
<A HREF="#'balloonexpr'">'balloonexpr'</A> + "" text to show in evaluation balloon
<A HREF="#'breakindent'">'breakindent'</A> + off don't indent when wrapping lines
<A HREF="#'cedit'">'cedit'</A> - {unchanged} {set vim default only on resetting 'cp'}
<A HREF="#'cindent'">'cindent'</A> + off no C code indentation
<A HREF="#'compatible'">'compatible'</A> - {unchanged} {set vim default only on resetting 'cp'}
<A HREF="#'copyindent'">'copyindent'</A> + off don't copy indent structure
<A HREF="#'cpoptions'">'cpoptions'</A> <A HREF="change.html#&">&</A> (all flags) Vi-compatible flags
'cscopepathcomp'+ 0 don't show directories in <A HREF="tagsrch.html#tags">tags</A> <A HREF="eval.html#list">list</A>
'cscoperelative'+ off
<A HREF="#'cscopetag'">'cscopetag'</A> + off don't use <A HREF="if_cscop.html#cscope">cscope</A> for "<A HREF="tagsrch.html#:tag">:tag</A>"
'cscopetagorder'+ 0 see |<A HREF="if_cscop.html#cscopetagorder">cscopetagorder</A>|
<A HREF="#'cscopeverbose'">'cscopeverbose'</A> + off see |<A HREF="if_cscop.html#cscopeverbose">cscopeverbose</A>|
<A HREF="#'delcombine'">'delcombine'</A> + off <A HREF="mbyte.html#unicode">unicode</A>: delete whole char combination
<A HREF="#'digraph'">'digraph'</A> + off no <A HREF="digraph.html#digraphs">digraphs</A>
<A HREF="#'esckeys'">'esckeys'</A> <A HREF="change.html#&">&</A> off no <Esc>-keys in <A HREF="insert.html#Insert">Insert</A> mode
<A HREF="#'expandtab'">'expandtab'</A> + off tabs not expanded to spaces
<A HREF="#'fileformats'">'fileformats'</A> <A HREF="change.html#&">&</A> "" no automatic file format detection,
"dos,unix" except for <A HREF="os_dos.html#DOS">DOS</A>, Windows and <A HREF="os_os2.html#OS/2">OS/2</A>
<A HREF="#'formatexpr'">'formatexpr'</A> + "" use <A HREF="#'formatprg'">'formatprg'</A> for auto-formatting
<A HREF="#'formatoptions'">'formatoptions'</A> <A HREF="change.html#&">&</A> "vt" <A HREF="intro.html#Vi">Vi</A> compatible <A HREF="change.html#formatting">formatting</A>
<A HREF="#'gdefault'">'gdefault'</A> + off no default '<A HREF="index.html#g">g</A>' flag for "<A HREF="change.html#:s">:s</A>"
<A HREF="#'history'">'history'</A> <A HREF="change.html#&">&</A> 0 no commandline <A HREF="cmdline.html#history">history</A>
<A HREF="#'hkmap'">'hkmap'</A> + off no Hebrew keyboard <A HREF="map.html#mapping">mapping</A>
<A HREF="#'hkmapp'">'hkmapp'</A> + off no phonetic Hebrew keyboard <A HREF="map.html#mapping">mapping</A>
<A HREF="#'hlsearch'">'hlsearch'</A> + off no highlighting of search matches
<A HREF="#'incsearch'">'incsearch'</A> + off no incremental searching
<A HREF="#'indentexpr'">'indentexpr'</A> + "" no indenting by <A HREF="eval.html#expression">expression</A>
<A HREF="#'insertmode'">'insertmode'</A> + off <A HREF="diff.html#do">do</A> not start in <A HREF="insert.html#Insert">Insert</A> mode
<A HREF="#'iskeyword'">'iskeyword'</A> <A HREF="change.html#&">&</A> "@,48-57,_" keywords contain alphanumeric
characters and '<A HREF="motion.html#_">_</A>'
<A HREF="#'joinspaces'">'joinspaces'</A> + on insert 2 spaces after period
<A HREF="#'modeline'">'modeline'</A> <A HREF="change.html#&">&</A> off no modelines
<A HREF="#'more'">'more'</A> <A HREF="change.html#&">&</A> off no pauses in listings
<A HREF="#'mzquantum'">'mzquantum'</A> - {unchanged} {set vim default only on resetting 'cp'}
<A HREF="#'numberwidth'">'numberwidth'</A> <A HREF="change.html#&">&</A> 8 min number of columns for line number
'preserveindent'+ off don't preserve current indent structure
when <A HREF="change.html#changing">changing</A> <A HREF="motion.html#it">it</A>
<A HREF="#'revins'">'revins'</A> + off no reverse insert
<A HREF="#'ruler'">'ruler'</A> + off no ruler
<A HREF="#'scrolljump'">'scrolljump'</A> + 1 no jump scroll
<A HREF="#'scrolloff'">'scrolloff'</A> + 0 no scroll offset
<A HREF="#'shelltemp'">'shelltemp'</A> - {unchanged} {set vim default only on resetting 'cp'}
<A HREF="#'shiftround'">'shiftround'</A> + off indent not rounded to shiftwidth
<A HREF="#'shortmess'">'shortmess'</A> <A HREF="change.html#&">&</A> "" no shortening of <A HREF="message.html#messages">messages</A>
<A HREF="#'showcmd'">'showcmd'</A> <A HREF="change.html#&">&</A> off command characters not shown
<A HREF="#'showmode'">'showmode'</A> <A HREF="change.html#&">&</A> off current mode not shown
<A HREF="#'sidescrolloff'">'sidescrolloff'</A> + 0 cursor moves to edge of screen in scroll
<A HREF="#'smartcase'">'smartcase'</A> + off no automatic ignore <A HREF="change.html#case">case</A> switch
<A HREF="#'smartindent'">'smartindent'</A> + off no smart indentation
<A HREF="#'smarttab'">'smarttab'</A> + off no smart <A HREF="intro.html#tab">tab</A> size
<A HREF="#'softtabstop'">'softtabstop'</A> + 0 tabs are always <A HREF="#'tabstop'">'tabstop'</A> positions
<A HREF="#'startofline'">'startofline'</A> + on goto startofline with some commands
<A HREF="#'tagcase'">'tagcase'</A> <A HREF="change.html#&">&</A> "followic" <A HREF="#'ignorecase'">'ignorecase'</A> when searching <A HREF="tagsrch.html#tags">tags</A> file
<A HREF="#'tagrelative'">'tagrelative'</A> <A HREF="change.html#&">&</A> off <A HREF="tagsrch.html#tag">tag</A> file names are not relative
<A HREF="#'termguicolors'">'termguicolors'</A> + off don't use highlight-(guifg|guibg)
<A HREF="#'textauto'">'textauto'</A> <A HREF="change.html#&">&</A> off no automatic textmode detection
<A HREF="#'textwidth'">'textwidth'</A> + 0 no automatic line wrap
<A HREF="#'tildeop'">'tildeop'</A> + off tilde is not an <A HREF="motion.html#operator">operator</A>
<A HREF="#'ttimeout'">'ttimeout'</A> + off no <A HREF="terminal.html#terminal">terminal</A> timeout
<A HREF="#'undofile'">'undofile'</A> + off don't use an <A HREF="undo.html#undo">undo</A> file
<A HREF="#'viminfo'">'viminfo'</A> - {unchanged} {set Vim default only on resetting 'cp'}
<A HREF="#'virtualedit'">'virtualedit'</A> + "" cursor can only be placed on characters
<A HREF="#'whichwrap'">'whichwrap'</A> <A HREF="change.html#&">&</A> "" left-right movements don't wrap
<A HREF="#'wildchar'">'wildchar'</A> <A HREF="change.html#&">&</A> <A HREF="scroll.html#CTRL-E">CTRL-E</A> only when the current value is <A HREF="motion.html#<Tab>"><Tab></A>
use <A HREF="scroll.html#CTRL-E">CTRL-E</A> for cmdline completion
<A HREF="#'writebackup'">'writebackup'</A> + on or off depends on the |<A HREF="various.html#+writebackup">+writebackup</A>| feature
*<A NAME="'complete'"></A><B>'complete'</B>* *<A NAME="'cpt'"></A><B>'cpt'</B>* *<A NAME="E535"></A><B>E535</B>*
<A HREF="#'complete'">'complete'</A> <A HREF="#'cpt'">'cpt'</A> <A HREF="eval.html#string">string</A> (default: ".,w,b,u,t,i")
local to buffer
{not in Vi}
This option specifies how keyword completion |<A HREF="insert.html#ins-completion">ins-completion</A>| works
when <A HREF="motion.html#CTRL-P">CTRL-P</A> or <A HREF="motion.html#CTRL-N">CTRL-N</A> are used. It is also used for whole-line
completion |<A HREF="insert.html#i_CTRL-X_CTRL-L">i_CTRL-X_CTRL-L</A>|. It indicates the type of completion
and the places to scan. It is a comma separated <A HREF="eval.html#list">list</A> of flags:
. scan the current buffer ('wrapscan' is ignored)
<A HREF="motion.html#w">w</A> scan <A HREF="windows.html#buffers">buffers</A> from other <A HREF="windows.html#windows">windows</A>
<A HREF="motion.html#b">b</A> scan other loaded <A HREF="windows.html#buffers">buffers</A> that are in the buffer <A HREF="eval.html#list">list</A>
<A HREF="undo.html#u">u</A> scan the unloaded <A HREF="windows.html#buffers">buffers</A> that are in the buffer <A HREF="eval.html#list">list</A>
<A HREF="undo.html#U">U</A> scan the <A HREF="windows.html#buffers">buffers</A> that are not in the buffer <A HREF="eval.html#list">list</A>
<A HREF="motion.html#k">k</A> scan the files given with the <A HREF="#'dictionary'">'dictionary'</A> option
kspell use the currently active spell checking |<A HREF="spell.html#spell">spell</A>|
k{dict} scan the file {dict}. Several "<A HREF="motion.html#k">k</A>" flags can be given,
patterns are valid too. For example:
<B> :set cpt=k/usr/dict/*,k~/spanish</B>
<A HREF="change.html#s">s</A> scan the files given with the <A HREF="#'thesaurus'">'thesaurus'</A> option
s{tsr} scan the file {tsr}. Several "<A HREF="change.html#s">s</A>" flags can be given, patterns
are valid too.
<A HREF="insert.html#i">i</A> scan current and included files
<A HREF="change.html#d">d</A> scan current and included files for defined name or <A HREF="map.html#macro">macro</A>
|<A HREF="insert.html#i_CTRL-X_CTRL-D">i_CTRL-X_CTRL-D</A>|
] <A HREF="tagsrch.html#tag">tag</A> completion
t same <A HREF="motion.html#as">as</A> "<A HREF="index.html#]">]</A>"
Unloaded <A HREF="windows.html#buffers">buffers</A> are not loaded, thus their autocmds |<A HREF="autocmd.html#:autocmd">:autocmd</A>| are
not executed, this may lead to unexpected completions from some files
(gzipped files for example). Unloaded <A HREF="windows.html#buffers">buffers</A> are not scanned for
whole-line completion.
The default is ".,w,b,u,t,i", which means to scan:
1. the current buffer
2. <A HREF="windows.html#buffers">buffers</A> in other <A HREF="windows.html#windows">windows</A>
3. other loaded <A HREF="windows.html#buffers">buffers</A>
4. unloaded <A HREF="windows.html#buffers">buffers</A>
5. <A HREF="tagsrch.html#tags">tags</A>
6. included files
As you can see, <A HREF="motion.html#CTRL-N">CTRL-N</A> and <A HREF="motion.html#CTRL-P">CTRL-P</A> can be used to <A HREF="diff.html#do">do</A> any 'iskeyword'-
based expansion (e.g., dictionary |<A HREF="insert.html#i_CTRL-X_CTRL-K">i_CTRL-X_CTRL-K</A>|, included patterns
|<A HREF="insert.html#i_CTRL-X_CTRL-I">i_CTRL-X_CTRL-I</A>|, <A HREF="tagsrch.html#tags">tags</A> |<A HREF="insert.html#i_CTRL-X_CTRL-]">i_CTRL-X_CTRL-]</A>| and normal expansions).
*<A NAME="'completefunc'"></A><B>'completefunc'</B>* *<A NAME="'cfu'"></A><B>'cfu'</B>*
<A HREF="#'completefunc'">'completefunc'</A> <A HREF="#'cfu'">'cfu'</A> <A HREF="eval.html#string">string</A> (default: empty)
local to buffer
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+eval">+eval</A>|
or |<A HREF="various.html#+insert_expand">+insert_expand</A>| features}
This option specifies a function to be used for <A HREF="insert.html#Insert">Insert</A> mode completion
with CTRL-X CTRL-U. |<A HREF="insert.html#i_CTRL-X_CTRL-U">i_CTRL-X_CTRL-U</A>|
See |<A HREF="insert.html#complete-functions">complete-functions</A>| for an explanation of how the function is
invoked and what <A HREF="motion.html#it">it</A> should return.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'completeopt'"></A><B>'completeopt'</B>* *<A NAME="'cot'"></A><B>'cot'</B>*
<A HREF="#'completeopt'">'completeopt'</A> <A HREF="#'cot'">'cot'</A> <A HREF="eval.html#string">string</A> (default: "menu,preview")
global
{not available when compiled without the
|<A HREF="various.html#+insert_expand">+insert_expand</A>| feature}
{not in Vi}
A comma separated <A HREF="eval.html#list">list</A> of <A HREF="#options">options</A> for <A HREF="insert.html#Insert">Insert</A> mode completion
|<A HREF="insert.html#ins-completion">ins-completion</A>|. The supported values are:
menu Use a popup menu to show the possible completions. The
menu is only shown when there is more than one match and
sufficient colors are available. |<A HREF="insert.html#ins-completion-menu">ins-completion-menu</A>|
menuone Use the popup menu also when there is only one match.
Useful when there is additional information about the
match, e.g., what file <A HREF="motion.html#it">it</A> comes from.
longest Only insert the longest common text of the matches. If
the menu is displayed you can use <A HREF="various.html#CTRL-L">CTRL-L</A> to add more
characters. Whether <A HREF="change.html#case">case</A> is ignored depends on the kind
of completion. For buffer text the <A HREF="#'ignorecase'">'ignorecase'</A> option is
used.
preview Show extra information about the currently selected
completion in the preview <A HREF="windows.html#window">window</A>. Only works in
combination with "menu" or "menuone".
noinsert Do not insert any text for a match until the user selects
a match from the menu. Only works in combination with
"menu" or "menuone". No effect if "longest" is present.
noselect Do not select a match in the menu, force the user to
select one from the menu. Only works in combination with
"menu" or "menuone".
*<A NAME="'concealcursor'"></A><B>'concealcursor'</B>* *<A NAME="'cocu'"></A><B>'cocu'</B>*
<A HREF="#'concealcursor'">'concealcursor'</A> <A HREF="#'cocu'">'cocu'</A> <A HREF="eval.html#string">string</A> (default: "")
local to <A HREF="windows.html#window">window</A>
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+conceal">+conceal</A>|
feature}
Sets the modes in which text in the cursor line can also be concealed.
When the current mode is listed then concealing happens just like in
other lines.
<A HREF="pattern.html#n">n</A> <A HREF="intro.html#Normal">Normal</A> mode
<A HREF="visual.html#v">v</A> <A HREF="visual.html#Visual">Visual</A> mode
<A HREF="insert.html#i">i</A> <A HREF="insert.html#Insert">Insert</A> mode
<A HREF="change.html#c">c</A> Command line editing, for <A HREF="#'incsearch'">'incsearch'</A>
'<A HREF="visual.html#v">v</A>' applies to all lines in the <A HREF="visual.html#Visual">Visual</A> area, not only the cursor.
A useful value is "nc". This is used in help files. So long <A HREF="motion.html#as">as</A> you
are moving around text is concealed, but when starting to insert text
or selecting a <A HREF="visual.html#Visual">Visual</A> area the concealed text is displayed, so that
you can see what you are doing.
Keep in mind that the cursor position is not always where it's
displayed. E.g., when moving vertically <A HREF="motion.html#it">it</A> may change column.
<A HREF="#'conceallevel'">'conceallevel'</A> <A HREF="#'cole'">'cole'</A> *<A NAME="'conceallevel'"></A><B>'conceallevel'</B>* *<A NAME="'cole'"></A><B>'cole'</B>*
number (default 0)
local to <A HREF="windows.html#window">window</A>
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+conceal">+conceal</A>|
feature}
Determine how text with the "conceal" <A HREF="syntax.html#syntax">syntax</A> attribute |<A HREF="syntax.html#:syn-conceal">:syn-conceal</A>|
is shown:
<B><FONT COLOR="PURPLE"> Value Effect </FONT></B>
0 Text is shown normally
1 Each block of concealed text is replaced with one
character. If the <A HREF="syntax.html#syntax">syntax</A> item does not have a custom
replacement character defined (see |<A HREF="syntax.html#:syn-cchar">:syn-cchar</A>|) the
character defined in <A HREF="#'listchars'">'listchars'</A> is used (default is a
space).
It is highlighted with the "Conceal" highlight group.
2 Concealed text is completely hidden unless <A HREF="motion.html#it">it</A> has a
custom replacement character defined (see
|<A HREF="syntax.html#:syn-cchar">:syn-cchar</A>|).
3 Concealed text is completely hidden.
Note: in the cursor line concealed text is not hidden, so that you can
edit and copy the text. This can be changed with the <A HREF="#'concealcursor'">'concealcursor'</A>
option.
*<A NAME="'confirm'"></A><B>'confirm'</B>* *<A NAME="'cf'"></A><B>'cf'</B>* *<A NAME="'noconfirm'"></A><B>'noconfirm'</B>* *<A NAME="'nocf'"></A><B>'nocf'</B>*
<A HREF="#'confirm'">'confirm'</A> <A HREF="#'cf'">'cf'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
When <A HREF="#'confirm'">'confirm'</A> is on, certain operations that would normally
fail because of unsaved changes to a buffer, e.g. "<A HREF="editing.html#:q">:q</A>" and "<A HREF="editing.html#:e">:e</A>",
instead raise a |<A HREF="gui_w32.html#dialog">dialog</A>| asking if you wish to save the current
file(s). You can still use a ! to unconditionally |<A HREF="editing.html#abandon">abandon</A>| a buffer.
If <A HREF="#'confirm'">'confirm'</A> is off you can still activate confirmation for one
command only (this is most useful in mappings) with the |<A HREF="editing.html#:confirm">:confirm</A>|
command.
Also see the |<A HREF="eval.html#confirm()">confirm()</A>| function and the '<A HREF="visual.html#v">v</A>' flag in <A HREF="#'guioptions'">'guioptions'</A>.
*<A NAME="'conskey'"></A><B>'conskey'</B>* *<A NAME="'consk'"></A><B>'consk'</B>* *<A NAME="'noconskey'"></A><B>'noconskey'</B>* *<A NAME="'noconsk'"></A><B>'noconsk'</B>*
<A HREF="#'conskey'">'conskey'</A> <A HREF="#'consk'">'consk'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi} {only for MS-DOS}
This was for <A HREF="os_msdos.html#MS-DOS">MS-DOS</A> and is no longer supported.
*<A NAME="'copyindent'"></A><B>'copyindent'</B>* *<A NAME="'ci'"></A><B>'ci'</B>* *<A NAME="'nocopyindent'"></A><B>'nocopyindent'</B>* *<A NAME="'noci'"></A><B>'noci'</B>*
<A HREF="#'copyindent'">'copyindent'</A> <A HREF="#'ci'">'ci'</A> <A HREF="#boolean">boolean</A> (default off)
local to buffer
{not in Vi}
Copy the structure of the existing lines indent when autoindenting a
new line. Normally the new indent is reconstructed by a series of
tabs followed by spaces <A HREF="motion.html#as">as</A> required (unless |<A HREF="#'expandtab'">'expandtab'</A>| is enabled,
in which <A HREF="change.html#case">case</A> only spaces are used). Enabling this option makes the
new line copy whatever characters were used for indenting on the
existing line. <A HREF="#'expandtab'">'expandtab'</A> has no effect on these characters, a <A HREF="intro.html#Tab">Tab</A>
remains a <A HREF="intro.html#Tab">Tab</A>. If the new indent is greater than on the existing
line, the remaining space is filled in the normal manner.
NOTE: This option is reset when <A HREF="#'compatible'">'compatible'</A> is set.
Also see <A HREF="#'preserveindent'">'preserveindent'</A>.
*<A NAME="'cpoptions'"></A><B>'cpoptions'</B>* *<A NAME="'cpo'"></A><B>'cpo'</B>* *<A NAME="cpo"></A><B>cpo</B>*
<A HREF="#'cpoptions'">'cpoptions'</A> <A HREF="#'cpo'">'cpo'</A> <A HREF="eval.html#string">string</A> (Vim default: "aABceFs",
<A HREF="intro.html#Vi">Vi</A> default: all flags)
global
{not in Vi}
A sequence of single character flags. When a character is present
this indicates Vi-compatible behavior. This is used for things where
not being Vi-compatible is mostly or sometimes preferred.
<A HREF="#'cpoptions'">'cpoptions'</A> stands for "compatible-options".
Commas can be added for readability.
To avoid problems with flags that are added in the future, use the
"+=" and "-=" feature of "<A HREF="#:set">:set</A>" |<A HREF="#add-option-flags">add-option-flags</A>|.
NOTE: This option is set to the <A HREF="intro.html#Vi">Vi</A> default value when <A HREF="#'compatible'">'compatible'</A> is
set and to the Vim default value when <A HREF="#'compatible'">'compatible'</A> is reset.
NOTE: This option is set to the POSIX default value at <A HREF="starting.html#startup">startup</A> when
the <A HREF="intro.html#Vi">Vi</A> default value would be used and the <A HREF="vi_diff.html#$VIM_POSIX">$VIM_POSIX</A> environment
variable exists |<A HREF="vi_diff.html#posix">posix</A>|. This means Vim tries to behave like the
POSIX specification.
<B><FONT COLOR="PURPLE"> contains behavior </FONT></B>
*<A NAME="cpo-a"></A><B>cpo-a</B>*
a When included, a "<A HREF="insert.html#:read">:read</A>" command with a file name
argument will set the alternate file name for the
current <A HREF="windows.html#window">window</A>.
*<A NAME="cpo-A"></A><B>cpo-A</B>*
A When included, a "<A HREF="editing.html#:write">:write</A>" command with a file name
argument will set the alternate file name for the
current <A HREF="windows.html#window">window</A>.
*<A NAME="cpo-b"></A><B>cpo-b</B>*
<A HREF="motion.html#b">b</A> "\|" in a "<A HREF="map.html#:map">:map</A>" command is recognized <A HREF="motion.html#as">as</A> the end of
the map command. The '\' is included in the <A HREF="map.html#mapping">mapping</A>,
the text after the '|' is interpreted <A HREF="motion.html#as">as</A> the next
command. Use a <A HREF="visual.html#CTRL-V">CTRL-V</A> instead of a <A HREF="intro.html#backslash">backslash</A> to
include the '|' in the <A HREF="map.html#mapping">mapping</A>. Applies to all
<A HREF="map.html#mapping">mapping</A>, abbreviation, menu and autocmd commands.
See also |<A HREF="map.html#map_bar">map_bar</A>|.
*<A NAME="cpo-B"></A><B>cpo-B</B>*
<A HREF="motion.html#B">B</A> A <A HREF="intro.html#backslash">backslash</A> has no special meaning in mappings,
<A HREF="map.html#abbreviations">abbreviations</A> and the "to" part of the menu commands.
Remove this flag to be able to use a <A HREF="intro.html#backslash">backslash</A> like a
<A HREF="visual.html#CTRL-V">CTRL-V</A>. For example, the command "<A HREF="map.html#:map">:map</A> X \<Esc>"
results in X being mapped to:
'<A HREF="motion.html#B">B</A>' included: "\^[" (^[ is a real <A HREF="intro.html#<Esc>"><Esc></A>)
'<A HREF="motion.html#B">B</A>' excluded: "<A HREF="intro.html#<Esc>"><Esc></A>" (5 characters)
('<' excluded in both cases)
*<A NAME="cpo-c"></A><B>cpo-c</B>*
<A HREF="change.html#c">c</A> Searching continues at the end of any match at the
cursor position, but not further than the start of the
next line. When not present searching continues
one character from the cursor position. With '<A HREF="change.html#c">c</A>'
"abababababab" only gets three matches when <A HREF="repeat.html#repeating">repeating</A>
"/abab", without '<A HREF="change.html#c">c</A>' there are five matches.
*<A NAME="cpo-C"></A><B>cpo-C</B>*
C Do not concatenate sourced lines that start with a
<A HREF="intro.html#backslash">backslash</A>. See |<A HREF="repeat.html#line-continuation">line-continuation</A>|.
*<A NAME="cpo-d"></A><B>cpo-d</B>*
<A HREF="change.html#d">d</A> Using "./" in the <A HREF="#'tags'">'tags'</A> option doesn't mean to use
the <A HREF="tagsrch.html#tags">tags</A> file relative to the current file, but the
<A HREF="tagsrch.html#tags">tags</A> file in the current directory.
*<A NAME="cpo-D"></A><B>cpo-D</B>*
<A HREF="change.html#D">D</A> Can't use CTRL-K to enter a <A HREF="digraph.html#digraph">digraph</A> after <A HREF="intro.html#Normal">Normal</A> mode
commands with a character argument, like |<A HREF="change.html#r">r</A>|, |<A HREF="motion.html#f">f</A>| and
|<A HREF="motion.html#t">t</A>|.
*<A NAME="cpo-e"></A><B>cpo-e</B>*
<A HREF="motion.html#e">e</A> When executing a <A HREF="sponsor.html#register">register</A> with ":@r", always add a
<A HREF="motion.html#<CR>"><CR></A> to the last line, also when the <A HREF="sponsor.html#register">register</A> is not
<A HREF="motion.html#linewise">linewise</A>. If this flag is not present, the <A HREF="sponsor.html#register">register</A>
is not <A HREF="motion.html#linewise">linewise</A> and the last line does not end in a
<A HREF="motion.html#<CR>"><CR></A>, then the last line is put on the command-line
and can be edited before hitting <A HREF="motion.html#<CR>"><CR></A>.
*<A NAME="cpo-E"></A><B>cpo-E</B>*
<A HREF="motion.html#E">E</A> It is an error when using "<A HREF="change.html#y">y</A>", "<A HREF="change.html#d">d</A>", "<A HREF="change.html#c">c</A>", "<A HREF="change.html#g~">g~</A>", "<A HREF="change.html#gu">gu</A>" or
"<A HREF="change.html#gU">gU</A>" on an Empty region. The operators only work when
at least one character is to be operate on. Example:
This makes "y0" fail in the first column.
*<A NAME="cpo-f"></A><B>cpo-f</B>*
<A HREF="motion.html#f">f</A> When included, a "<A HREF="insert.html#:read">:read</A>" command with a file name
argument will set the file name for the current buffer,
if the current buffer doesn't have a file name yet.
*<A NAME="cpo-F"></A><B>cpo-F</B>*
<A HREF="motion.html#F">F</A> When included, a "<A HREF="editing.html#:write">:write</A>" command with a file name
argument will set the file name for the current
buffer, if the current buffer doesn't have a file name
yet. Also see |<A HREF="#cpo-P">cpo-P</A>|.
*<A NAME="cpo-g"></A><B>cpo-g</B>*
<A HREF="index.html#g">g</A> Goto line 1 when using "<A HREF="editing.html#:edit">:edit</A>" without argument.
*<A NAME="cpo-H"></A><B>cpo-H</B>*
<A HREF="motion.html#H">H</A> When using "<A HREF="insert.html#I">I</A>" on a line with only blanks, insert
before the last blank. Without this flag insert after
the last blank.
*<A NAME="cpo-i"></A><B>cpo-i</B>*
<A HREF="insert.html#i">i</A> When included, interrupting the reading of a file will
leave <A HREF="motion.html#it">it</A> modified.
*<A NAME="cpo-I"></A><B>cpo-I</B>*
I When moving the cursor up or down just after <A HREF="insert.html#inserting">inserting</A>
indent for <A HREF="#'autoindent'">'autoindent'</A>, <A HREF="diff.html#do">do</A> not delete the indent.
*<A NAME="cpo-j"></A><B>cpo-j</B>*
<A HREF="motion.html#j">j</A> When joining lines, only add two spaces after a '<A HREF="repeat.html#.">.</A>',
not after '<A HREF="change.html#!">!</A>' or '<A HREF="pattern.html#?">?</A>'. Also see <A HREF="#'joinspaces'">'joinspaces'</A>.
*<A NAME="cpo-J"></A><B>cpo-J</B>*
<A HREF="change.html#J">J</A> A |<A HREF="motion.html#sentence">sentence</A>| has to be followed by two spaces after
the '<A HREF="repeat.html#.">.</A>', '<A HREF="change.html#!">!</A>' or '<A HREF="pattern.html#?">?</A>'. A <A HREF="motion.html#<Tab>"><Tab></A> is not recognized <A HREF="motion.html#as">as</A>
white space.
*<A NAME="cpo-k"></A><B>cpo-k</B>*
<A HREF="motion.html#k">k</A> Disable the recognition of raw key codes in
mappings, <A HREF="map.html#abbreviations">abbreviations</A>, and the "to" part of menu
commands. For example, if <Key> sends ^[OA (where ^[
is <Esc>), the command "<A HREF="map.html#:map">:map</A> X ^[OA" results in X
being mapped to:
'<A HREF="motion.html#k">k</A>' included: "^[OA" (3 characters)
'<A HREF="motion.html#k">k</A>' excluded: "<Key>" (one key code)
Also see the '<A HREF="change.html#<"><</A>' flag below.
*<A NAME="cpo-K"></A><B>cpo-K</B>*
<A HREF="various.html#K">K</A> Don't wait for a key code to complete when <A HREF="motion.html#it">it</A> is
halfway a <A HREF="map.html#mapping">mapping</A>. This breaks <A HREF="map.html#mapping">mapping</A> <F1><F1> when
only part of the second <A HREF="helphelp.html#<F1>"><F1></A> has been read. It
enables cancelling the <A HREF="map.html#mapping">mapping</A> by typing <F1><Esc>.
*<A NAME="cpo-l"></A><B>cpo-l</B>*
<A HREF="motion.html#l">l</A> Backslash in a <A HREF="motion.html#[]">[]</A> range in a search <A HREF="pattern.html#pattern">pattern</A> is taken
literally, only "\]", "\^", "\-" and "\\" are special.
See |<A HREF="pattern.html#/[]">/[]</A>|
'<A HREF="motion.html#l">l</A>' included: "/[ \t]" finds <A HREF="motion.html#<Space>"><Space></A>, '\' and '<A HREF="motion.html#t">t</A>'
'<A HREF="motion.html#l">l</A>' excluded: "/[ \t]" finds <A HREF="motion.html#<Space>"><Space></A> and <A HREF="motion.html#<Tab>"><Tab></A>
Also see |<A HREF="#cpo-\">cpo-\</A>|.
*<A NAME="cpo-L"></A><B>cpo-L</B>*
<A HREF="motion.html#L">L</A> When the <A HREF="#'list'">'list'</A> option is set, <A HREF="#'wrapmargin'">'wrapmargin'</A>,
<A HREF="#'textwidth'">'textwidth'</A>, <A HREF="#'softtabstop'">'softtabstop'</A> and Virtual <A HREF="insert.html#Replace">Replace</A> mode
(see |<A HREF="change.html#gR">gR</A>|) <A HREF="intro.html#count">count</A> a <A HREF="motion.html#<Tab>"><Tab></A> <A HREF="motion.html#as">as</A> two characters, instead of
the normal behavior of a <A HREF="motion.html#<Tab>"><Tab></A>.
*<A NAME="cpo-m"></A><B>cpo-m</B>*
<A HREF="motion.html#m">m</A> When included, a showmatch will always wait half a
second. When not included, a showmatch will wait half
a second or until a character is typed. |<A HREF="#'showmatch'">'showmatch'</A>|
*<A NAME="cpo-M"></A><B>cpo-M</B>*
<A HREF="motion.html#M">M</A> When excluded, "<A HREF="motion.html#%">%</A>" matching will take backslashes into
account. Thus in "<A HREF="motion.html#(">(</A> \( )" and "\( ( \)" the outer
parenthesis match. When included "<A HREF="motion.html#%">%</A>" ignores
backslashes, which is <A HREF="intro.html#Vi">Vi</A> compatible.
*<A NAME="cpo-n"></A><B>cpo-n</B>*
<A HREF="pattern.html#n">n</A> When included, the column used for <A HREF="#'number'">'number'</A> and
<A HREF="#'relativenumber'">'relativenumber'</A> will also be used for text of wrapped
lines.
*<A NAME="cpo-o"></A><B>cpo-o</B>*
<A HREF="insert.html#o">o</A> Line offset to search command is not remembered for
next search.
*<A NAME="cpo-O"></A><B>cpo-O</B>*
<A HREF="insert.html#O">O</A> Don't complain if a file is being overwritten, even
when <A HREF="motion.html#it">it</A> didn't exist when editing <A HREF="motion.html#it">it</A>. This is a
protection against a file unexpectedly created by
someone else. <A HREF="intro.html#Vi">Vi</A> didn't complain about this.
*<A NAME="cpo-p"></A><B>cpo-p</B>*
<A HREF="change.html#p">p</A> <A HREF="intro.html#Vi">Vi</A> compatible Lisp indenting. When not present, a
slightly better algorithm is used.
*<A NAME="cpo-P"></A><B>cpo-P</B>*
<A HREF="change.html#P">P</A> When included, a "<A HREF="editing.html#:write">:write</A>" command that appends to a
file will set the file name for the current buffer, if
the current buffer doesn't have a file name yet and
the 'F' flag is also included |<A HREF="#cpo-F">cpo-F</A>|.
*<A NAME="cpo-q"></A><B>cpo-q</B>*
<A HREF="repeat.html#q">q</A> When joining multiple lines leave the cursor at the
position where <A HREF="motion.html#it">it</A> would be when joining two lines.
*<A NAME="cpo-r"></A><B>cpo-r</B>*
<A HREF="change.html#r">r</A> Redo ("." command) uses "<A HREF="pattern.html#/">/</A>" to repeat a search
command, instead of the actually used search <A HREF="eval.html#string">string</A>.
*<A NAME="cpo-R"></A><B>cpo-R</B>*
<A HREF="change.html#R">R</A> Remove marks from filtered lines. Without this flag
marks are kept like |<A HREF="motion.html#:keepmarks">:keepmarks</A>| was used.
*<A NAME="cpo-s"></A><B>cpo-s</B>*
<A HREF="change.html#s">s</A> Set buffer <A HREF="#options">options</A> when entering the buffer for the
first time. This is like <A HREF="motion.html#it">it</A> is in Vim version 3.0.
And <A HREF="motion.html#it">it</A> is the default. If not present the <A HREF="#options">options</A> are
set when the buffer is created.
*<A NAME="cpo-S"></A><B>cpo-S</B>*
<A HREF="change.html#S">S</A> Set buffer <A HREF="#options">options</A> always when entering a buffer
(except <A HREF="#'readonly'">'readonly'</A>, <A HREF="#'fileformat'">'fileformat'</A>, <A HREF="#'filetype'">'filetype'</A> and
<A HREF="#'syntax'">'syntax'</A>). This is the (most) <A HREF="intro.html#Vi">Vi</A> compatible setting.
The <A HREF="#options">options</A> are set to the values in the current
buffer. When you change an option and go to another
buffer, the value is copied. Effectively makes the
buffer <A HREF="#options">options</A> global to all <A HREF="windows.html#buffers">buffers</A>.
'<A HREF="change.html#s">s</A>' '<A HREF="change.html#S">S</A>' copy buffer <A HREF="#options">options</A>
no no when buffer created
yes no when buffer first entered (default)
X yes each time when buffer entered (vi comp.)
*<A NAME="cpo-t"></A><B>cpo-t</B>*
t Search <A HREF="pattern.html#pattern">pattern</A> for the <A HREF="tagsrch.html#tag">tag</A> command is remembered for
"<A HREF="pattern.html#n">n</A>" command. Otherwise Vim only puts the <A HREF="pattern.html#pattern">pattern</A> in
the <A HREF="cmdline.html#history">history</A> for search <A HREF="pattern.html#pattern">pattern</A>, but doesn't change the
last used search <A HREF="pattern.html#pattern">pattern</A>.
*<A NAME="cpo-u"></A><B>cpo-u</B>*
u Undo is <A HREF="intro.html#Vi">Vi</A> compatible. See |<A HREF="undo.html#undo-two-ways">undo-two-ways</A>|.
*<A NAME="cpo-v"></A><B>cpo-v</B>*
<A HREF="visual.html#v">v</A> Backspaced characters remain visible on the screen in
<A HREF="insert.html#Insert">Insert</A> mode. Without this flag the characters are
erased from the screen right away. With this flag the
screen newly typed text overwrites backspaced
characters.
*<A NAME="cpo-w"></A><B>cpo-w</B>*
<A HREF="motion.html#w">w</A> When using "<A HREF="change.html#cw">cw</A>" on a blank character, only change one
character and not all blanks until the start of the
next <A HREF="motion.html#word">word</A>.
*<A NAME="cpo-W"></A><B>cpo-W</B>*
<A HREF="motion.html#W">W</A> Don't overwrite a readonly file. When omitted, "<A HREF="editing.html#:w!">:w!</A>"
overwrites a readonly file, if possible.
*<A NAME="cpo-x"></A><B>cpo-x</B>*
<A HREF="change.html#x">x</A> <A HREF="intro.html#<Esc>"><Esc></A> on the command-line executes the command-line.
The default in Vim is to <A HREF="editing.html#abandon">abandon</A> the command-line,
because <Esc> normally aborts a command. |<A HREF="cmdline.html#c_<Esc>">c_<Esc></A>|
*<A NAME="cpo-X"></A><B>cpo-X</B>*
X When using a <A HREF="intro.html#count">count</A> with "<A HREF="change.html#R">R</A>" the replaced text is
deleted only once. Also when <A HREF="repeat.html#repeating">repeating</A> "<A HREF="change.html#R">R</A>" with "<A HREF="repeat.html#.">.</A>"
and a <A HREF="intro.html#count">count</A>.
*<A NAME="cpo-y"></A><B>cpo-y</B>*
<A HREF="change.html#y">y</A> A <A HREF="change.html#yank">yank</A> command can be redone with "<A HREF="repeat.html#.">.</A>".
*<A NAME="cpo-Z"></A><B>cpo-Z</B>*
Z When using "w!" while the <A HREF="#'readonly'">'readonly'</A> option is set,
don't reset <A HREF="#'readonly'">'readonly'</A>.
*<A NAME="cpo-!"></A><B>cpo-!</B>*
! When redoing a <A HREF="change.html#filter">filter</A> command, use the last used
external command, whatever <A HREF="motion.html#it">it</A> was. Otherwise the last
used -filter- command is used.
*<A NAME="cpo-$"></A><B>cpo-$</B>*
$ When making a change to one line, don't redisplay the
line, but put a '<A HREF="motion.html#$">$</A>' at the end of the changed text.
The changed text will be overwritten when you type the
new text. The line is redisplayed if you type any
command that moves the cursor from the insertion
point.
*<A NAME="cpo-%"></A><B>cpo-%</B>*
<A HREF="motion.html#%">%</A> Vi-compatible matching is done for the "<A HREF="motion.html#%">%</A>" command.
Does not recognize "#if", "#endif", etc.
Does not recognize "/*" and "*/".
Parens inside single and double <A HREF="quotes.html#quotes">quotes</A> are also
counted, causing a <A HREF="eval.html#string">string</A> that contains a paren to
disturb the matching. For example, in a line like
"if (strcmp("foo(", s))" the first paren does not
match the last one. When this flag is not included,
parens inside single and double <A HREF="quotes.html#quotes">quotes</A> are treated
specially. When matching a paren outside of <A HREF="quotes.html#quotes">quotes</A>,
everything inside <A HREF="quotes.html#quotes">quotes</A> is ignored. When matching a
paren inside <A HREF="quotes.html#quotes">quotes</A>, <A HREF="motion.html#it">it</A> will find the matching one (if
there is one). This works very well for C programs.
This flag is also used for other features, such <A HREF="motion.html#as">as</A>
<A HREF="indent.html#C-indenting">C-indenting</A>.
*<A NAME="cpo--"></A><B>cpo--</B>*
- When included, a vertical <A HREF="intro.html#movement">movement</A> command fails when
<A HREF="motion.html#it">it</A> would go above the first line or below the last
line. Without <A HREF="motion.html#it">it</A> the cursor moves to the first or
last line, unless <A HREF="motion.html#it">it</A> already was in that line.
Applies to the commands "<A HREF="motion.html#-">-</A>", "<A HREF="motion.html#k">k</A>", <A HREF="motion.html#CTRL-P">CTRL-P</A>, "<A HREF="motion.html#+">+</A>", "<A HREF="motion.html#j">j</A>",
<A HREF="motion.html#CTRL-N">CTRL-N</A>, <A HREF="motion.html#CTRL-J">CTRL-J</A> and ":1234".
*<A NAME="cpo-+"></A><B>cpo-+</B>*
+ When included, a "<A HREF="editing.html#:write">:write</A> file" command will reset the
<A HREF="#'modified'">'modified'</A> flag of the buffer, even though the buffer
itself may still be different from its file.
*<A NAME="cpo-star"></A><B>cpo-star</B>*
* Use ":*" in the same way <A HREF="motion.html#as">as</A> "<A HREF="repeat.html#:@">:@</A>". When not included,
":*" is an alias for ":'<,'>", select the <A HREF="visual.html#Visual">Visual</A> area.
*<A NAME="cpo-<"></A><B>cpo-<</B>*
< Disable the recognition of special key codes in |<A HREF="intro.html#<>"><></A>|
form in mappings, <A HREF="map.html#abbreviations">abbreviations</A>, and the "to" part of
menu commands. For example, the command
"<A HREF="map.html#:map">:map</A> X <Tab>" results in X being mapped to:
'<A HREF="change.html#<"><</A>' included: "<A HREF="motion.html#<Tab>"><Tab></A>" (5 characters)
'<A HREF="change.html#<"><</A>' excluded: "^I" (^I is a real <A HREF="motion.html#<Tab>"><Tab></A>)
Also see the '<A HREF="motion.html#k">k</A>' flag above.
*<A NAME="cpo->"></A><B>cpo-></B>*
<A HREF="change.html#>">></A> When appending to a <A HREF="sponsor.html#register">register</A>, put a line break before
the appended text.
*<A NAME="cpo-;"></A><B>cpo-;</B>*
; When using |<A HREF="motion.html#,">,</A>| or |<A HREF="motion.html#;">;</A>| to repeat the last |<A HREF="motion.html#t">t</A>| search
and the cursor is right in front of the searched
character, the cursor won't move. When not included,
the cursor would skip over <A HREF="motion.html#it">it</A> and jump to the
following occurrence.
POSIX flags. These are not included in the <A HREF="intro.html#Vi">Vi</A> default value, except
when <A HREF="vi_diff.html#$VIM_POSIX">$VIM_POSIX</A> was set on <A HREF="starting.html#startup">startup</A>. |<A HREF="vi_diff.html#posix">posix</A>|
<B><FONT COLOR="PURPLE"> contains behavior </FONT></B>
*<A NAME="cpo-#"></A><B>cpo-#</B>*
# A <A HREF="intro.html#count">count</A> before "<A HREF="change.html#D">D</A>", "<A HREF="insert.html#o">o</A>" and "<A HREF="insert.html#O">O</A>" has no effect.
*<A NAME="cpo-&"></A><B>cpo-&</B>*
<A HREF="change.html#&">&</A> When "<A HREF="recover.html#:preserve">:preserve</A>" was used keep the swap file when
<A HREF="starting.html#exiting">exiting</A> normally while this buffer is still loaded.
This flag is tested when <A HREF="starting.html#exiting">exiting</A>.
*<A NAME="cpo-\"></A><B>cpo-\</B>*
\ Backslash in a <A HREF="motion.html#[]">[]</A> range in a search <A HREF="pattern.html#pattern">pattern</A> is taken
literally, only "\]" is special See |<A HREF="pattern.html#/[]">/[]</A>|
'\' included: "/[ \-]" finds <A HREF="motion.html#<Space>"><Space></A>, '\' and '<A HREF="motion.html#-">-</A>'
'\' excluded: "/[ \-]" finds <A HREF="motion.html#<Space>"><Space></A> and '<A HREF="motion.html#-">-</A>'
Also see |<A HREF="#cpo-l">cpo-l</A>|.
*<A NAME="cpo-/"></A><B>cpo-/</B>*
/ When "<A HREF="motion.html#%">%</A>" is used <A HREF="motion.html#as">as</A> the replacement <A HREF="eval.html#string">string</A> in a |<A HREF="change.html#:s">:s</A>|
command, use the previous replacement <A HREF="eval.html#string">string</A>. |<A HREF="change.html#:s%">:s%</A>|
*<A NAME="cpo-{"></A><B>cpo-{</B>*
{ The |<A HREF="motion.html#{">{</A>| and |<A HREF="motion.html#}">}</A>| commands also stop at a "{" character
at the start of a line.
*<A NAME="cpo-."></A><B>cpo-.</B>*
. The "<A HREF="editing.html#:chdir">:chdir</A>" and "<A HREF="editing.html#:cd">:cd</A>" commands fail if the current
buffer is modified, unless ! is used. Vim doesn't
need this, since <A HREF="motion.html#it">it</A> remembers the full path of an
opened file.
*<A NAME="cpo-bar"></A><B>cpo-bar</B>*
| The value of the $LINES and $COLUMNS environment
<A HREF="eval.html#variables">variables</A> overrule the <A HREF="terminal.html#terminal">terminal</A> size values obtained
with system specific <A HREF="eval.html#functions">functions</A>.
*<A NAME="'cryptmethod'"></A><B>'cryptmethod'</B>* *<A NAME="'cm'"></A><B>'cm'</B>*
<A HREF="#'cryptmethod'">'cryptmethod'</A> <A HREF="#'cm'">'cm'</A> <A HREF="eval.html#string">string</A> (default "<A HREF="pi_zip.html#zip">zip</A>")
global or local to buffer |<A HREF="#global-local">global-local</A>|
{not in Vi}
Method used for <A HREF="editing.html#encryption">encryption</A> when the buffer is written to a file:
*<A NAME="pkzip"></A><B>pkzip</B>*
<A HREF="pi_zip.html#zip">zip</A> PkZip compatible method. A weak kind of <A HREF="editing.html#encryption">encryption</A>.
Backwards compatible with Vim 7.2 and older.
*<A NAME="blowfish"></A><B>blowfish</B>*
<A HREF="#blowfish">blowfish</A> Blowfish method. Medium strong <A HREF="editing.html#encryption">encryption</A> but <A HREF="motion.html#it">it</A> has
an implementation flaw. Requires Vim 7.3 or later,
files can NOT be read by Vim 7.2 and older. This adds
a "seed" to the file, every time you write the file
the encrypted bytes will be different.
*<A NAME="blowfish2"></A><B>blowfish2</B>*
<A HREF="#blowfish2">blowfish2</A> Blowfish method. Medium strong <A HREF="editing.html#encryption">encryption</A>. Requires
Vim 7.4.401 or later, files can NOT be read by Vim 7.3
and older. This adds a "seed" to the file, every time
you write the file the encrypted bytes will be
different. The whole <A HREF="undo.html#undo">undo</A> file is encrypted, not just
the pieces of text.
You should use "<A HREF="#blowfish2">blowfish2</A>", also to re-encrypt older files.
When reading an encrypted file <A HREF="#'cryptmethod'">'cryptmethod'</A> will be set automatically
to the detected method of the file being read. Thus if you write <A HREF="motion.html#it">it</A>
without <A HREF="change.html#changing">changing</A> <A HREF="#'cryptmethod'">'cryptmethod'</A> the same method will be used.
Changing <A HREF="#'cryptmethod'">'cryptmethod'</A> does not <A HREF="motion.html#mark">mark</A> the file <A HREF="motion.html#as">as</A> modified, you have to
explicitly write <A HREF="motion.html#it">it</A>, you don't get a warning unless there are other
modifications. Also see |<A HREF="editing.html#:X">:X</A>|.
When setting the global value to an empty <A HREF="eval.html#string">string</A>, <A HREF="motion.html#it">it</A> will end up with
the value "<A HREF="pi_zip.html#zip">zip</A>". When setting the local value to an empty <A HREF="eval.html#string">string</A> the
buffer will use the global value.
When a new <A HREF="editing.html#encryption">encryption</A> method is added in a later version of Vim, and
the current version does not recognize <A HREF="motion.html#it">it</A>, you will get *<A NAME="E821"></A><B>E821</B>* .
You need to edit this file with the later version of Vim.
*<A NAME="'cscopepathcomp'"></A><B>'cscopepathcomp'</B>* *<A NAME="'cspc'"></A><B>'cspc'</B>*
<A HREF="#'cscopepathcomp'">'cscopepathcomp'</A> <A HREF="#'cspc'">'cspc'</A> number (default 0)
global
{not available when compiled without the |<A HREF="various.html#+cscope">+cscope</A>|
feature}
{not in Vi}
Determines how many components of the path to show in a <A HREF="eval.html#list">list</A> of <A HREF="tagsrch.html#tags">tags</A>.
See |<A HREF="if_cscop.html#cscopepathcomp">cscopepathcomp</A>|.
NOTE: This option is set to 0 when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'cscopeprg'"></A><B>'cscopeprg'</B>* *<A NAME="'csprg'"></A><B>'csprg'</B>*
<A HREF="#'cscopeprg'">'cscopeprg'</A> <A HREF="#'csprg'">'csprg'</A> <A HREF="eval.html#string">string</A> (default "<A HREF="if_cscop.html#cscope">cscope</A>")
global
{not available when compiled without the |<A HREF="various.html#+cscope">+cscope</A>|
feature}
{not in Vi}
Specifies the command to execute cscope. See |<A HREF="if_cscop.html#cscopeprg">cscopeprg</A>|.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'cscopequickfix'"></A><B>'cscopequickfix'</B>* *<A NAME="'csqf'"></A><B>'csqf'</B>*
<A HREF="#'cscopequickfix'">'cscopequickfix'</A> <A HREF="#'csqf'">'csqf'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not available when compiled without the |<A HREF="various.html#+cscope">+cscope</A>|
or |<A HREF="various.html#+quickfix">+quickfix</A>| features}
{not in Vi}
Specifies whether to use <A HREF="quickfix.html#quickfix">quickfix</A> <A HREF="windows.html#window">window</A> to show <A HREF="if_cscop.html#cscope">cscope</A> results.
See |<A HREF="if_cscop.html#cscopequickfix">cscopequickfix</A>|.
*<A NAME="'cscoperelative'"></A><B>'cscoperelative'</B>* *<A NAME="'csre'"></A><B>'csre'</B>* *<A NAME="'nocscoperelative'"></A><B>'nocscoperelative'</B>* *<A NAME="'nocsre'"></A><B>'nocsre'</B>*
<A HREF="#'cscoperelative'">'cscoperelative'</A> <A HREF="#'csre'">'csre'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not available when compiled without the |<A HREF="various.html#+cscope">+cscope</A>|
feature}
{not in Vi}
In the absence of a prefix (-P) for <A HREF="if_cscop.html#cscope">cscope</A>. setting this option enables
to use the basename of cscope.out path <A HREF="motion.html#as">as</A> the prefix.
See |<A HREF="if_cscop.html#cscoperelative">cscoperelative</A>|.
NOTE: This option is reset when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'cscopetag'"></A><B>'cscopetag'</B>* *<A NAME="'cst'"></A><B>'cst'</B>* *<A NAME="'nocscopetag'"></A><B>'nocscopetag'</B>* *<A NAME="'nocst'"></A><B>'nocst'</B>*
<A HREF="#'cscopetag'">'cscopetag'</A> <A HREF="#'cst'">'cst'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not available when compiled without the |<A HREF="various.html#+cscope">+cscope</A>|
feature}
{not in Vi}
Use cscope for <A HREF="tagsrch.html#tag">tag</A> commands. See |<A HREF="if_cscop.html#cscope-options">cscope-options</A>|.
NOTE: This option is reset when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'cscopetagorder'"></A><B>'cscopetagorder'</B>* *<A NAME="'csto'"></A><B>'csto'</B>*
<A HREF="#'cscopetagorder'">'cscopetagorder'</A> <A HREF="#'csto'">'csto'</A> number (default 0)
global
{not available when compiled without the |<A HREF="various.html#+cscope">+cscope</A>|
feature}
{not in Vi}
Determines the order in which "<A HREF="if_cscop.html#:cstag">:cstag</A>" performs a search. See
|<A HREF="if_cscop.html#cscopetagorder">cscopetagorder</A>|.
NOTE: This option is set to 0 when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'cscopeverbose'"></A><B>'cscopeverbose'</B>* *<A NAME="'csverb'"></A><B>'csverb'</B>*
*<A NAME="'nocscopeverbose'"></A><B>'nocscopeverbose'</B>* *<A NAME="'nocsverb'"></A><B>'nocsverb'</B>*
<A HREF="#'cscopeverbose'">'cscopeverbose'</A> <A HREF="#'csverb'">'csverb'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not available when compiled without the |<A HREF="various.html#+cscope">+cscope</A>|
feature}
{not in Vi}
Give <A HREF="message.html#messages">messages</A> when adding a cscope database. See |<A HREF="if_cscop.html#cscopeverbose">cscopeverbose</A>|.
NOTE: This option is reset when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'cursorbind'"></A><B>'cursorbind'</B>* *<A NAME="'crb'"></A><B>'crb'</B>* *<A NAME="'nocursorbind'"></A><B>'nocursorbind'</B>* *<A NAME="'nocrb'"></A><B>'nocrb'</B>*
<A HREF="#'cursorbind'">'cursorbind'</A> <A HREF="#'crb'">'crb'</A> <A HREF="#boolean">boolean</A> (default off)
local to <A HREF="windows.html#window">window</A>
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+cursorbind">+cursorbind</A>|
feature}
When this option is set, <A HREF="motion.html#as">as</A> the cursor in the current
<A HREF="windows.html#window">window</A> moves other cursorbound <A HREF="windows.html#windows">windows</A> (windows that also have
this option set) move their cursors to the corresponding line and
column. This option is useful for viewing the
differences between two versions of a file (see 'diff'); in <A HREF="diff.html#diff">diff</A> mode,
inserted and deleted lines (though not characters within a line) are
taken into account.
*<A NAME="'cursorcolumn'"></A><B>'cursorcolumn'</B>* *<A NAME="'cuc'"></A><B>'cuc'</B>* *<A NAME="'nocursorcolumn'"></A><B>'nocursorcolumn'</B>* *<A NAME="'nocuc'"></A><B>'nocuc'</B>*
<A HREF="#'cursorcolumn'">'cursorcolumn'</A> <A HREF="#'cuc'">'cuc'</A> <A HREF="#boolean">boolean</A> (default off)
local to <A HREF="windows.html#window">window</A>
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+syntax">+syntax</A>|
feature}
Highlight the screen column of the cursor with CursorColumn
|<A HREF="syntax.html#hl-CursorColumn">hl-CursorColumn</A>|. Useful to align text. Will make screen redrawing
slower.
If you only want the highlighting in the current <A HREF="windows.html#window">window</A> you can use
these autocommands:
<B> au WinLeave * set nocursorline nocursorcolumn</B>
<B> au WinEnter * set cursorline cursorcolumn</B>
*<A NAME="'cursorline'"></A><B>'cursorline'</B>* *<A NAME="'cul'"></A><B>'cul'</B>* *<A NAME="'nocursorline'"></A><B>'nocursorline'</B>* *<A NAME="'nocul'"></A><B>'nocul'</B>*
<A HREF="#'cursorline'">'cursorline'</A> <A HREF="#'cul'">'cul'</A> <A HREF="#boolean">boolean</A> (default off)
local to <A HREF="windows.html#window">window</A>
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+syntax">+syntax</A>|
feature}
Highlight the screen line of the cursor with CursorLine
|<A HREF="syntax.html#hl-CursorLine">hl-CursorLine</A>|. Useful to easily spot the cursor. Will make screen
redrawing slower.
When <A HREF="visual.html#Visual">Visual</A> mode is active the highlighting isn't used to make <A HREF="motion.html#it">it</A>
easier to see the selected text.
*<A NAME="'debug'"></A><B>'debug'</B>*
<A HREF="#'debug'">'debug'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not in Vi}
These values can be used:
msg Error <A HREF="message.html#messages">messages</A> that would otherwise be omitted will be given
anyway.
throw Error <A HREF="message.html#messages">messages</A> that would otherwise be omitted will be given
anyway and also throw an exception and set |<A HREF="eval.html#v:errmsg">v:errmsg</A>|.
beep A message will be given when otherwise only a beep would be
produced.
The values can be combined, separated by a comma.
"msg" and "throw" are useful for debugging <A HREF="#'foldexpr'">'foldexpr'</A>, <A HREF="#'formatexpr'">'formatexpr'</A> or
<A HREF="#'indentexpr'">'indentexpr'</A>.
*<A NAME="'define'"></A><B>'define'</B>* *<A NAME="'def'"></A><B>'def'</B>*
<A HREF="#'define'">'define'</A> <A HREF="#'def'">'def'</A> <A HREF="eval.html#string">string</A> (default "^\s*#\s*define")
global or local to buffer |<A HREF="#global-local">global-local</A>|
{not in Vi}
<A HREF="pattern.html#Pattern">Pattern</A> to be used to find a <A HREF="map.html#macro">macro</A> definition. It is a search
<A HREF="pattern.html#pattern">pattern</A>, just like for the "<A HREF="pattern.html#/">/</A>" command. This option is used for the
commands like "<A HREF="tagsrch.html#[i">[i</A>" and "<A HREF="tagsrch.html#[d">[d</A>" |<A HREF="tagsrch.html#include-search">include-search</A>|. The <A HREF="#'isident'">'isident'</A> option is
used to recognize the defined name after the match:
{match with 'define'}{non-ID chars}{defined name}{non-ID char}
See |<A HREF="#option-backslash">option-backslash</A>| about <A HREF="insert.html#inserting">inserting</A> backslashes to include a space
or <A HREF="intro.html#backslash">backslash</A>.
The default value is for C programs. For C++ this value would be
useful, to include const type declarations:
<B> ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)</B>
When using the "<A HREF="#:set">:set</A>" command, you need to double the backslashes!
*<A NAME="'delcombine'"></A><B>'delcombine'</B>* *<A NAME="'deco'"></A><B>'deco'</B>* *<A NAME="'nodelcombine'"></A><B>'nodelcombine'</B>* *<A NAME="'nodeco'"></A><B>'nodeco'</B>*
<A HREF="#'delcombine'">'delcombine'</A> <A HREF="#'deco'">'deco'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+multi_byte">+multi_byte</A>|
feature}
If editing <A HREF="mbyte.html#Unicode">Unicode</A> and this option is set, backspace and <A HREF="intro.html#Normal">Normal</A> mode
"<A HREF="change.html#x">x</A>" delete each combining character on its own. When <A HREF="motion.html#it">it</A> is off (the
default) the character along with its combining characters are
deleted.
Note: When <A HREF="#'delcombine'">'delcombine'</A> is set "xx" may work different from "2x"!
This is useful for <A HREF="arabic.html#Arabic">Arabic</A>, Hebrew and many other languages where one
may have combining characters overtop of base characters, and want
to remove only the combining ones.
NOTE: This option is reset when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'dictionary'"></A><B>'dictionary'</B>* *<A NAME="'dict'"></A><B>'dict'</B>*
<A HREF="#'dictionary'">'dictionary'</A> <A HREF="#'dict'">'dict'</A> <A HREF="eval.html#string">string</A> (default "")
global or local to buffer |<A HREF="#global-local">global-local</A>|
{not in Vi}
<A HREF="eval.html#List">List</A> of file names, separated by commas, that are used to lookup words
for keyword completion commands |<A HREF="insert.html#i_CTRL-X_CTRL-K">i_CTRL-X_CTRL-K</A>|. Each file should
contain a <A HREF="eval.html#list">list</A> of words. This can be one <A HREF="motion.html#word">word</A> per line, or several
words per line, separated by non-keyword characters (white space is
preferred). Maximum line length is 510 bytes.
When this option is empty, or an entry "<A HREF="spell.html#spell">spell</A>" is present, <A HREF="spell.html#spell">spell</A>
checking is enabled the currently active spelling is used. |<A HREF="spell.html#spell">spell</A>|
To include a comma in a file name precede <A HREF="motion.html#it">it</A> with a <A HREF="intro.html#backslash">backslash</A>. Spaces
after a comma are ignored, otherwise spaces are included in the file
name. See |<A HREF="#option-backslash">option-backslash</A>| about using backslashes.
This has nothing to <A HREF="diff.html#do">do</A> with the |<A HREF="eval.html#Dictionary">Dictionary</A>| variable type.
Where to find a <A HREF="eval.html#list">list</A> of words?
- On FreeBSD, there is the file "/usr/share/dict/words".
- In the Simtel archive, look in the "msdos/linguist" directory.
- In "miscfiles" of the GNU collection.
The use of |<A HREF="#:set+=">:set+=</A>| and |<A HREF="#:set-=">:set-=</A>| is preferred when adding or removing
directories from the <A HREF="eval.html#list">list</A>. This avoids problems when a future version
uses another default.
Backticks cannot be used in this option for security reasons.
*<A NAME="'diff'"></A><B>'diff'</B>* *<A NAME="'nodiff'"></A><B>'nodiff'</B>*
<A HREF="#'diff'">'diff'</A> <A HREF="#boolean">boolean</A> (default off)
local to <A HREF="windows.html#window">window</A>
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+diff">+diff</A>|
feature}
Join the current <A HREF="windows.html#window">window</A> in the group of <A HREF="windows.html#windows">windows</A> that shows differences
between files. See |<A HREF="diff.html#vimdiff">vimdiff</A>|.
*<A NAME="'dex'"></A><B>'dex'</B>* *<A NAME="'diffexpr'"></A><B>'diffexpr'</B>*
<A HREF="#'diffexpr'">'diffexpr'</A> <A HREF="#'dex'">'dex'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+diff">+diff</A>|
feature}
Expression which is evaluated to obtain an ed-style <A HREF="diff.html#diff">diff</A> file from two
versions of a file. See |<A HREF="diff.html#diff-diffexpr">diff-diffexpr</A>|.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'dip'"></A><B>'dip'</B>* *<A NAME="'diffopt'"></A><B>'diffopt'</B>*
<A HREF="#'diffopt'">'diffopt'</A> <A HREF="#'dip'">'dip'</A> <A HREF="eval.html#string">string</A> (default "filler")
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+diff">+diff</A>|
feature}
Option settings for <A HREF="diff.html#diff">diff</A> mode. It can consist of the following items.
All are optional. Items must be separated by a comma.
filler Show filler lines, to keep the text
synchronized with a <A HREF="windows.html#window">window</A> that has inserted
lines at the same position. Mostly useful
when <A HREF="windows.html#windows">windows</A> are side-by-side and <A HREF="#'scrollbind'">'scrollbind'</A>
is set.
context:{n} Use a context of {n} lines between a change
and a fold that contains unchanged lines.
When omitted a context of six lines is used.
See |<A HREF="fold.html#fold-diff">fold-diff</A>|.
icase Ignore changes in <A HREF="change.html#case">case</A> of text. "<A HREF="insert.html#a">a</A>" and "<A HREF="insert.html#A">A</A>"
are considered the same. Adds the "<A HREF="starting.html#-i">-i</A>" flag
to the "<A HREF="diff.html#diff">diff</A>" command if <A HREF="#'diffexpr'">'diffexpr'</A> is empty.
iwhite Ignore changes in amount of white space. Adds
the "<A HREF="starting.html#-b">-b</A>" flag to the "<A HREF="diff.html#diff">diff</A>" command if
<A HREF="#'diffexpr'">'diffexpr'</A> is empty. Check the documentation
of the "<A HREF="diff.html#diff">diff</A>" command for what this does
exactly. It should ignore adding trailing
white space, but not leading white space.
horizontal Start <A HREF="diff.html#diff">diff</A> mode with horizontal splits (unless
explicitly specified otherwise).
vertical Start <A HREF="diff.html#diff">diff</A> mode with vertical splits (unless
explicitly specified otherwise).
hiddenoff Do not use <A HREF="diff.html#diff">diff</A> mode for a buffer when <A HREF="motion.html#it">it</A>
becomes hidden.
foldcolumn:{n} Set the <A HREF="#'foldcolumn'">'foldcolumn'</A> option to {n} when
starting <A HREF="diff.html#diff">diff</A> mode. Without this 2 is used.
Examples:
<B> :set diffopt=filler,context:4</B>
<B> :set diffopt=</B>
<B> :set diffopt=filler,foldcolumn:3</B>
*<A NAME="'digraph'"></A><B>'digraph'</B>* *<A NAME="'dg'"></A><B>'dg'</B>* *<A NAME="'nodigraph'"></A><B>'nodigraph'</B>* *<A NAME="'nodg'"></A><B>'nodg'</B>*
<A HREF="#'digraph'">'digraph'</A> <A HREF="#'dg'">'dg'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+digraphs">+digraphs</A>|
feature}
Enable the entering of <A HREF="digraph.html#digraphs">digraphs</A> in <A HREF="insert.html#Insert">Insert</A> mode with {char1} <A HREF="motion.html#<BS>"><BS></A>
{char2}. See |<A HREF="digraph.html#digraphs">digraphs</A>|.
NOTE: This option is reset when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'directory'"></A><B>'directory'</B>* *<A NAME="'dir'"></A><B>'dir'</B>*
<A HREF="#'directory'">'directory'</A> <A HREF="#'dir'">'dir'</A> <A HREF="eval.html#string">string</A> (default for <A HREF="os_amiga.html#Amiga">Amiga</A>: ".,t:",
for <A HREF="os_msdos.html#MS-DOS">MS-DOS</A> and <A HREF="os_win32.html#Win32">Win32</A>: ".,$TEMP,c:\tmp,c:\temp"
for <A HREF="os_unix.html#Unix">Unix</A>: ".,~/tmp,/var/tmp,/tmp")
global
<A HREF="eval.html#List">List</A> of directory names for the swap file, separated with commas.
- The swap file will be created in the first directory where this is
possible.
- Empty means that no swap file will be used (recovery is
impossible!).
- A directory "<A HREF="repeat.html#.">.</A>" means to put the swap file in the same directory <A HREF="motion.html#as">as</A>
the edited file. On <A HREF="os_unix.html#Unix">Unix</A>, a dot is prepended to the file name, so
<A HREF="motion.html#it">it</A> doesn't show in a directory listing. On <A HREF="os_win32.html#MS-Windows">MS-Windows</A> the "hidden"
attribute is set and a dot prepended if possible.
- A directory starting with "./" (or ".\" for <A HREF="os_msdos.html#MS-DOS">MS-DOS</A> et al.) means to
put the swap file relative to where the edited file is. The leading
"<A HREF="repeat.html#.">.</A>" is replaced with the path name of the edited file.
- For <A HREF="os_unix.html#Unix">Unix</A> and <A HREF="os_win32.html#Win32">Win32</A>, if a directory ends in two path separators "<A HREF="version7.html#//">//</A>"
or "\\", the swap file name will be built from the complete path to
the file with all path separators substituted to percent '<A HREF="motion.html#%">%</A>' <A HREF="sign.html#signs">signs</A>.
This will ensure file name uniqueness in the preserve directory.
On <A HREF="os_win32.html#Win32">Win32</A>, when a separating comma is following, you must use "<A HREF="version7.html#//">//</A>",
since "\\" will include the comma in the file name.
- Spaces after the comma are ignored, other spaces are considered part
of the directory name. To have a space at the start of a directory
name, precede <A HREF="motion.html#it">it</A> with a <A HREF="intro.html#backslash">backslash</A>.
- To include a comma in a directory name precede <A HREF="motion.html#it">it</A> with a <A HREF="intro.html#backslash">backslash</A>.
- A directory name may end in an '<A HREF="cmdline.html#:">:</A>' or '<A HREF="pattern.html#/">/</A>'.
- Environment <A HREF="eval.html#variables">variables</A> are expanded |<A HREF="#:set_env">:set_env</A>|.
- Careful with '\' characters, type one before a space, type two to
get one in the option (see |<A HREF="#option-backslash">option-backslash</A>|), for example:
<B> :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces</B>
- For backwards compatibility with Vim version 3.0 a '<A HREF="change.html#>">></A>' at the start
of the option is removed.
Using "<A HREF="repeat.html#.">.</A>" first in the <A HREF="eval.html#list">list</A> is recommended. This means that editing
the same file <A HREF="if_cscop.html#twice">twice</A> will result in a warning. Using "/tmp" on <A HREF="os_unix.html#Unix">Unix</A> is
discouraged: When the system crashes you lose the swap file.
"/var/tmp" is often not cleared when rebooting, thus is a better
choice than "/tmp". But <A HREF="motion.html#it">it</A> can contain a lot of files, your swap
files get lost in the crowd. That is why a "tmp" directory in your
home directory is tried first.
The use of |<A HREF="#:set+=">:set+=</A>| and |<A HREF="#:set-=">:set-=</A>| is preferred when adding or removing
directories from the <A HREF="eval.html#list">list</A>. This avoids problems when a future version
uses another default.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
{Vi: directory to put temp file in, defaults to "/tmp"}
*<A NAME="'display'"></A><B>'display'</B>* *<A NAME="'dy'"></A><B>'dy'</B>*
<A HREF="#'display'">'display'</A> <A HREF="#'dy'">'dy'</A> <A HREF="eval.html#string">string</A> (default "", set to "truncate" in
|<A HREF="defaults.html">defaults.vim</A>|)
global
{not in Vi}
Change the way text is displayed. This is comma separated <A HREF="eval.html#list">list</A> of
flags:
lastline When included, <A HREF="motion.html#as">as</A> much <A HREF="motion.html#as">as</A> possible of the last line
in a <A HREF="windows.html#window">window</A> will be displayed. "@@@" is put in the
last columns of the last screen line to indicate the
rest of the line is not displayed.
truncate Like "lastline", but "@@@" is displayed in the first
column of the last screen line. Overrules "lastline".
uhex Show unprintable characters hexadecimal <A HREF="motion.html#as">as</A> <xx>
instead of using ^C and ~C.
When neither "lastline" nor "truncate" is included, a last line that
doesn't fit is replaced with "<A HREF="repeat.html#@">@</A>" lines.
*<A NAME="'eadirection'"></A><B>'eadirection'</B>* *<A NAME="'ead'"></A><B>'ead'</B>*
<A HREF="#'eadirection'">'eadirection'</A> <A HREF="#'ead'">'ead'</A> <A HREF="eval.html#string">string</A> (default "both")
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+vertsplit">+vertsplit</A>|
feature}
Tells when the <A HREF="#'equalalways'">'equalalways'</A> option applies:
ver vertically, width of <A HREF="windows.html#windows">windows</A> is not affected
hor horizontally, height of <A HREF="windows.html#windows">windows</A> is not affected
both width and height of <A HREF="windows.html#windows">windows</A> is affected
*<A NAME="'ed'"></A><B>'ed'</B>* *<A NAME="'edcompatible'"></A><B>'edcompatible'</B>* *<A NAME="'noed'"></A><B>'noed'</B>* *<A NAME="'noedcompatible'"></A><B>'noedcompatible'</B>*
<A HREF="#'edcompatible'">'edcompatible'</A> <A HREF="#'ed'">'ed'</A> <A HREF="#boolean">boolean</A> (default off)
global
Makes the '<A HREF="index.html#g">g</A>' and '<A HREF="change.html#c">c</A>' flags of the "<A HREF="change.html#:substitute">:substitute</A>" command to be
toggled each time the flag is given. See |<A HREF="change.html#complex-change">complex-change</A>|. See
also <A HREF="#'gdefault'">'gdefault'</A> option.
Switching this option on may break plugins!
*<A NAME="'emoji'"></A><B>'emoji'</B>* *<A NAME="'emo'"></A><B>'emo'</B>* *<A NAME="'noemoji'"></A><B>'noemoji'</B>* *<A NAME="'noemo'"></A><B>'noemo'</B>*
<A HREF="#'emoji'">'emoji'</A> <A HREF="#'emo'">'emo'</A> <A HREF="#boolean">boolean</A> (default: on)
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+multi_byte">+multi_byte</A>|
feature}
When on all <A HREF="mbyte.html#Unicode">Unicode</A> emoji characters are considered to be full width.
*<A NAME="'encoding'"></A><B>'encoding'</B>* *<A NAME="'enc'"></A><B>'enc'</B>* *<A NAME="E543"></A><B>E543</B>*
<A HREF="#'encoding'">'encoding'</A> <A HREF="#'enc'">'enc'</A> <A HREF="eval.html#string">string</A> (default: "latin1" or value from $LANG)
global
{only available when compiled with the |<A HREF="various.html#+multi_byte">+multi_byte</A>|
feature}
{not in Vi}
Sets the character encoding used inside Vim. It applies to text in
the <A HREF="windows.html#buffers">buffers</A>, <A HREF="change.html#registers">registers</A>, Strings in expressions, text stored in the
<A HREF="starting.html#viminfo">viminfo</A> file, etc. It sets the kind of characters which Vim can work
with. See |<A HREF="mbyte.html#encoding-names">encoding-names</A>| for the possible values.
NOTE: Changing this option will not change the encoding of the
existing text in Vim. It may cause non-ASCII text to become invalid.
It should normally be kept at its default value, or set when Vim
starts up. See |<A HREF="mbyte.html#multibyte">multibyte</A>|. To <A HREF="editing.html#reload">reload</A> the <A HREF="gui.html#menus">menus</A> see |<A HREF="mlang.html#:menutrans">:menutrans</A>|.
This option cannot be set from a |<A HREF="#modeline">modeline</A>|. It would most likely
corrupt the text.
NOTE: For <A HREF="gui_x11.html#GTK+">GTK+</A> 2 or later, <A HREF="motion.html#it">it</A> is highly recommended to set <A HREF="#'encoding'">'encoding'</A>
to "<A HREF="mbyte.html#utf-8">utf-8</A>". Although care has been taken to allow different values of
<A HREF="#'encoding'">'encoding'</A>, "<A HREF="mbyte.html#utf-8">utf-8</A>" is the natural choice for the environment and
avoids unnecessary conversion overhead. "<A HREF="mbyte.html#utf-8">utf-8</A>" has not been made
the default to prevent different behavior of the <A HREF="gui.html#GUI">GUI</A> and <A HREF="terminal.html#terminal">terminal</A>
versions, and to avoid <A HREF="change.html#changing">changing</A> the encoding of newly created files
without your knowledge (in <A HREF="change.html#case">case</A> <A HREF="#'fileencodings'">'fileencodings'</A> is empty).
The character encoding of files can be different from <A HREF="#'encoding'">'encoding'</A>.
This is specified with <A HREF="#'fileencoding'">'fileencoding'</A>. The conversion is done with
<A HREF="eval.html#iconv()">iconv()</A> or <A HREF="motion.html#as">as</A> specified with <A HREF="#'charconvert'">'charconvert'</A>.
If you need to know whether <A HREF="#'encoding'">'encoding'</A> is a <A HREF="mbyte.html#multi-byte">multi-byte</A> encoding, you
can use:
<B> if has("multi_byte_encoding")</B>
Normally <A HREF="#'encoding'">'encoding'</A> will be equal to your current <A HREF="mbyte.html#locale">locale</A>. This will
be the default if Vim recognizes your environment settings. If
<A HREF="#'encoding'">'encoding'</A> is not set to the current <A HREF="mbyte.html#locale">locale</A>, <A HREF="#'termencoding'">'termencoding'</A> must be
set to convert typed and displayed text. See |<A HREF="mbyte.html#encoding-table">encoding-table</A>|.
When you set this option, <A HREF="motion.html#it">it</A> fires the |<A HREF="autocmd.html#EncodingChanged">EncodingChanged</A>| <A HREF="autocmd.html#autocommand">autocommand</A>
event so that you can set up fonts if necessary.
When the option is set, the value is converted to <A HREF="change.html#lowercase">lowercase</A>. Thus
you can set <A HREF="motion.html#it">it</A> with <A HREF="change.html#uppercase">uppercase</A> values too. Underscores are translated
to '<A HREF="motion.html#-">-</A>' <A HREF="sign.html#signs">signs</A>.
When the encoding is recognized, <A HREF="motion.html#it">it</A> is changed to the standard name.
For example "Latin-1" becomes "latin1", "ISO_88592" becomes
"iso-8859-2" and "<A HREF="mbyte.html#utf8">utf8</A>" becomes "<A HREF="mbyte.html#utf-8">utf-8</A>".
Note: "latin1" is also used when the encoding could not be detected.
This only works when editing files in the same encoding! When the
actual character set is not latin1, make sure <A HREF="#'fileencoding'">'fileencoding'</A> and
<A HREF="#'fileencodings'">'fileencodings'</A> are empty. When conversion is needed, switch to using
<A HREF="mbyte.html#utf-8">utf-8</A>.
When "<A HREF="mbyte.html#unicode">unicode</A>", "ucs-2" or "ucs-4" is used, Vim internally uses <A HREF="mbyte.html#utf-8">utf-8</A>.
You don't notice this while editing, but <A HREF="motion.html#it">it</A> does matter for the
|<A HREF="starting.html#viminfo-file">viminfo-file</A>|. And Vim expects the <A HREF="terminal.html#terminal">terminal</A> to use <A HREF="mbyte.html#utf-8">utf-8</A> too. Thus
setting <A HREF="#'encoding'">'encoding'</A> to one of these values instead of <A HREF="mbyte.html#utf-8">utf-8</A> only has
effect for encoding used for files when <A HREF="#'fileencoding'">'fileencoding'</A> is empty.
When <A HREF="#'encoding'">'encoding'</A> is set to a <A HREF="mbyte.html#Unicode">Unicode</A> encoding, and <A HREF="#'fileencodings'">'fileencodings'</A> was
not set yet, the default for <A HREF="#'fileencodings'">'fileencodings'</A> is changed.
*<A NAME="'endofline'"></A><B>'endofline'</B>* *<A NAME="'eol'"></A><B>'eol'</B>* *<A NAME="'noendofline'"></A><B>'noendofline'</B>* *<A NAME="'noeol'"></A><B>'noeol'</B>*
<A HREF="#'endofline'">'endofline'</A> <A HREF="#'eol'">'eol'</A> <A HREF="#boolean">boolean</A> (default on)
local to buffer
{not in Vi}
When <A HREF="editing.html#writing">writing</A> a file and this option is off and the <A HREF="#'binary'">'binary'</A> option
is on, or <A HREF="#'fixeol'">'fixeol'</A> option is off, no <A HREF="intro.html#<EOL>"><EOL></A> will be written for the
last line in the file. This option is automatically set or reset when
starting to edit a new file, depending on whether file has an <A HREF="intro.html#<EOL>"><EOL></A>
for the last line in the file. Normally you don't have to set or
reset this option.
When <A HREF="#'binary'">'binary'</A> is off and <A HREF="#'fixeol'">'fixeol'</A> is on the value is not used when
<A HREF="editing.html#writing">writing</A> the file. When <A HREF="#'binary'">'binary'</A> is on or <A HREF="#'fixeol'">'fixeol'</A> is off <A HREF="motion.html#it">it</A> is used
to remember the presence of a <A HREF="intro.html#<EOL>"><EOL></A> for the last line in the file, so
that when you write the file the situation from the original file can
be kept. But you can change <A HREF="motion.html#it">it</A> if you want to.
*<A NAME="'equalalways'"></A><B>'equalalways'</B>* *<A NAME="'ea'"></A><B>'ea'</B>* *<A NAME="'noequalalways'"></A><B>'noequalalways'</B>* *<A NAME="'noea'"></A><B>'noea'</B>*
<A HREF="#'equalalways'">'equalalways'</A> <A HREF="#'ea'">'ea'</A> <A HREF="#boolean">boolean</A> (default on)
global
{not in Vi}
When on, all the <A HREF="windows.html#windows">windows</A> are automatically made the same size after
splitting or closing a <A HREF="windows.html#window">window</A>. This also happens the moment the
option is switched on. When off, splitting a <A HREF="windows.html#window">window</A> will reduce the
size of the current <A HREF="windows.html#window">window</A> and leave the other <A HREF="windows.html#windows">windows</A> the same. When
closing a <A HREF="windows.html#window">window</A> the extra lines are given to the <A HREF="windows.html#window">window</A> next to <A HREF="motion.html#it">it</A>
(depending on <A HREF="#'splitbelow'">'splitbelow'</A> and <A HREF="#'splitright'">'splitright'</A>).
When mixing vertically and horizontally split <A HREF="windows.html#windows">windows</A>, a minimal size
is computed and some <A HREF="windows.html#windows">windows</A> may be larger if there is room. The
<A HREF="#'eadirection'">'eadirection'</A> option tells in which direction the size is affected.
Changing the height and width of a <A HREF="windows.html#window">window</A> can be avoided by setting
<A HREF="#'winfixheight'">'winfixheight'</A> and <A HREF="#'winfixwidth'">'winfixwidth'</A>, respectively.
If a <A HREF="windows.html#window">window</A> size is specified when creating a new <A HREF="windows.html#window">window</A> sizes are
currently not equalized (it's complicated, but may be implemented in
the future).
*<A NAME="'equalprg'"></A><B>'equalprg'</B>* *<A NAME="'ep'"></A><B>'ep'</B>*
<A HREF="#'equalprg'">'equalprg'</A> <A HREF="#'ep'">'ep'</A> <A HREF="eval.html#string">string</A> (default "")
global or local to buffer |<A HREF="#global-local">global-local</A>|
{not in Vi}
External program to use for "<A HREF="change.html#=">=</A>" command. When this option is empty
the internal <A HREF="change.html#formatting">formatting</A> <A HREF="eval.html#functions">functions</A> are used; either <A HREF="#'lisp'">'lisp'</A>, <A HREF="#'cindent'">'cindent'</A>
or <A HREF="#'indentexpr'">'indentexpr'</A>. When Vim was compiled without internal <A HREF="change.html#formatting">formatting</A>,
the "indent" program is used.
Environment <A HREF="eval.html#variables">variables</A> are expanded |<A HREF="#:set_env">:set_env</A>|. See |<A HREF="#option-backslash">option-backslash</A>|
about including spaces and backslashes.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'errorbells'"></A><B>'errorbells'</B>* *<A NAME="'eb'"></A><B>'eb'</B>* *<A NAME="'noerrorbells'"></A><B>'noerrorbells'</B>* *<A NAME="'noeb'"></A><B>'noeb'</B>*
<A HREF="#'errorbells'">'errorbells'</A> <A HREF="#'eb'">'eb'</A> <A HREF="#boolean">boolean</A> (default off)
global
Ring the bell (beep or screen flash) for error <A HREF="message.html#messages">messages</A>. This only
makes a difference for error <A HREF="message.html#messages">messages</A>, the bell will be used always
for a lot of <A HREF="message.html#errors">errors</A> without a message (e.g., hitting <A HREF="intro.html#<Esc>"><Esc></A> in <A HREF="intro.html#Normal">Normal</A>
mode). See <A HREF="#'visualbell'">'visualbell'</A> on how to make the bell behave like a beep,
screen flash or <A HREF="diff.html#do">do</A> nothing. See <A HREF="#'belloff'">'belloff'</A> to finetune when to ring the
bell.
*<A NAME="'errorfile'"></A><B>'errorfile'</B>* *<A NAME="'ef'"></A><B>'ef'</B>*
<A HREF="#'errorfile'">'errorfile'</A> <A HREF="#'ef'">'ef'</A> <A HREF="eval.html#string">string</A> (Amiga default: "AztecC.Err",
others: "errors.err")
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+quickfix">+quickfix</A>|
feature}
Name of the errorfile for the QuickFix mode (see |<A HREF="quickfix.html#:cf">:cf</A>|).
When the "<A HREF="starting.html#-q">-q</A>" command-line argument is used, <A HREF="#'errorfile'">'errorfile'</A> is set to the
following argument. See |<A HREF="starting.html#-q">-q</A>|.
NOT used for the "<A HREF="quickfix.html#:make">:make</A>" command. See <A HREF="#'makeef'">'makeef'</A> for that.
Environment <A HREF="eval.html#variables">variables</A> are expanded |<A HREF="#:set_env">:set_env</A>|.
See |<A HREF="#option-backslash">option-backslash</A>| about including spaces and backslashes.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'errorformat'"></A><B>'errorformat'</B>* *<A NAME="'efm'"></A><B>'efm'</B>*
<A HREF="#'errorformat'">'errorformat'</A> <A HREF="#'efm'">'efm'</A> <A HREF="eval.html#string">string</A> (default is very long)
global or local to buffer |<A HREF="#global-local">global-local</A>|
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+quickfix">+quickfix</A>|
feature}
Scanf-like description of the format for the lines in the error file
(see |<A HREF="quickfix.html#errorformat">errorformat</A>|).
*<A NAME="'esckeys'"></A><B>'esckeys'</B>* *<A NAME="'ek'"></A><B>'ek'</B>* *<A NAME="'noesckeys'"></A><B>'noesckeys'</B>* *<A NAME="'noek'"></A><B>'noek'</B>*
<A HREF="#'esckeys'">'esckeys'</A> <A HREF="#'ek'">'ek'</A> <A HREF="#boolean">boolean</A> (Vim default: on, <A HREF="intro.html#Vi">Vi</A> default: off)
global
{not in Vi}
Function keys that start with an <A HREF="intro.html#<Esc>"><Esc></A> are recognized in <A HREF="insert.html#Insert">Insert</A>
mode. When this option is off, the cursor and function keys cannot be
used in <A HREF="insert.html#Insert">Insert</A> mode if they start with an <A HREF="intro.html#<Esc>"><Esc></A>. The advantage of
this is that the single <A HREF="intro.html#<Esc>"><Esc></A> is recognized immediately, instead of
after one second. Instead of resetting this option, you might want to
try <A HREF="change.html#changing">changing</A> the values for <A HREF="#'timeoutlen'">'timeoutlen'</A> and <A HREF="#'ttimeoutlen'">'ttimeoutlen'</A>. Note that
when <A HREF="#'esckeys'">'esckeys'</A> is off, you can still map anything, but the cursor keys
won't work by default.
NOTE: This option is set to the <A HREF="intro.html#Vi">Vi</A> default value when <A HREF="#'compatible'">'compatible'</A> is
set and to the Vim default value when <A HREF="#'compatible'">'compatible'</A> is reset.
*<A NAME="'eventignore'"></A><B>'eventignore'</B>* *<A NAME="'ei'"></A><B>'ei'</B>*
<A HREF="#'eventignore'">'eventignore'</A> <A HREF="#'ei'">'ei'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+autocmd">+autocmd</A>|
feature}
A <A HREF="eval.html#list">list</A> of <A HREF="autocmd.html#autocommand">autocommand</A> event names, which are to be ignored.
When set to "all" or when "all" is one of the items, all <A HREF="autocmd.html#autocommand">autocommand</A>
events are ignored, autocommands will not be executed.
Otherwise this is a comma separated <A HREF="eval.html#list">list</A> of event names. Example:
<B> :set ei=WinEnter,WinLeave</B>
*<A NAME="'expandtab'"></A><B>'expandtab'</B>* *<A NAME="'et'"></A><B>'et'</B>* *<A NAME="'noexpandtab'"></A><B>'noexpandtab'</B>* *<A NAME="'noet'"></A><B>'noet'</B>*
<A HREF="#'expandtab'">'expandtab'</A> <A HREF="#'et'">'et'</A> <A HREF="#boolean">boolean</A> (default off)
local to buffer
{not in Vi}
In <A HREF="insert.html#Insert">Insert</A> mode: Use the appropriate number of spaces to insert a
<A HREF="motion.html#<Tab>"><Tab></A>. Spaces are used in indents with the '<A HREF="change.html#>">></A>' and '<A HREF="change.html#<"><</A>' commands and
when <A HREF="#'autoindent'">'autoindent'</A> is on. To insert a real <A HREF="intro.html#tab">tab</A> when <A HREF="#'expandtab'">'expandtab'</A> is
on, use CTRL-V<Tab>. See also |<A HREF="change.html#:retab">:retab</A>| and |<A HREF="insert.html#ins-expandtab">ins-expandtab</A>|.
This option is reset when the <A HREF="#'paste'">'paste'</A> option is set and restored when
the <A HREF="#'paste'">'paste'</A> option is reset.
NOTE: This option is reset when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'exrc'"></A><B>'exrc'</B>* *<A NAME="'ex'"></A><B>'ex'</B>* *<A NAME="'noexrc'"></A><B>'noexrc'</B>* *<A NAME="'noex'"></A><B>'noex'</B>*
<A HREF="#'exrc'">'exrc'</A> <A HREF="#'ex'">'ex'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
Enables the reading of <A HREF="starting.html#.vimrc">.vimrc</A>, <A HREF="starting.html#.exrc">.exrc</A> and <A HREF="gui.html#.gvimrc">.gvimrc</A> in the current
directory.
Setting this option is a potential security leak. E.g., consider
unpacking a package or fetching files from github, a <A HREF="starting.html#.vimrc">.vimrc</A> in there
might be a trojan horse. BETTER NOT SET THIS OPTION!
Instead, define an <A HREF="autocmd.html#autocommand">autocommand</A> in your <A HREF="starting.html#.vimrc">.vimrc</A> to set <A HREF="#options">options</A> for a
matching directory.
If you <A HREF="diff.html#do">do</A> switch this option on you should also consider setting the
<A HREF="#'secure'">'secure'</A> option (see |<A HREF="starting.html#initialization">initialization</A>|).
Also see |<A HREF="starting.html#.vimrc">.vimrc</A>| and |<A HREF="gui.html#gui-init">gui-init</A>|.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'fileencoding'"></A><B>'fileencoding'</B>* *<A NAME="'fenc'"></A><B>'fenc'</B>* *<A NAME="E213"></A><B>E213</B>*
<A HREF="#'fileencoding'">'fileencoding'</A> <A HREF="#'fenc'">'fenc'</A> <A HREF="eval.html#string">string</A> (default: "")
local to buffer
{only available when compiled with the |<A HREF="various.html#+multi_byte">+multi_byte</A>|
feature}
{not in Vi}
Sets the character encoding for the file of this buffer.
When <A HREF="#'fileencoding'">'fileencoding'</A> is different from <A HREF="#'encoding'">'encoding'</A>, conversion will be
done when <A HREF="editing.html#writing">writing</A> the file. For reading see below.
When <A HREF="#'fileencoding'">'fileencoding'</A> is empty, the same value <A HREF="motion.html#as">as</A> <A HREF="#'encoding'">'encoding'</A> will be
used (no conversion when reading or <A HREF="editing.html#writing">writing</A> a file).
No error will be given when the value is set, only when <A HREF="motion.html#it">it</A> is used,
only when <A HREF="editing.html#writing">writing</A> a file.
Conversion will also be done when <A HREF="#'encoding'">'encoding'</A> and <A HREF="#'fileencoding'">'fileencoding'</A> are
both a <A HREF="mbyte.html#Unicode">Unicode</A> encoding and <A HREF="#'fileencoding'">'fileencoding'</A> is not <A HREF="mbyte.html#utf-8">utf-8</A>. That's
because internally <A HREF="mbyte.html#Unicode">Unicode</A> is always stored <A HREF="motion.html#as">as</A> <A HREF="mbyte.html#utf-8">utf-8</A>.
WARNING: Conversion can cause loss of information! When
<A HREF="#'encoding'">'encoding'</A> is "<A HREF="mbyte.html#utf-8">utf-8</A>" or another <A HREF="mbyte.html#Unicode">Unicode</A> encoding, conversion
is most likely done in a way that the reverse conversion
results in the same text. When <A HREF="#'encoding'">'encoding'</A> is not "<A HREF="mbyte.html#utf-8">utf-8</A>" some
characters may be lost!
See <A HREF="#'encoding'">'encoding'</A> for the possible values. Additionally, values may be
specified that can be handled by the converter, see
|<A HREF="mbyte.html#mbyte-conversion">mbyte-conversion</A>|.
When reading a file <A HREF="#'fileencoding'">'fileencoding'</A> will be set from <A HREF="#'fileencodings'">'fileencodings'</A>.
To read a file in a certain encoding <A HREF="motion.html#it">it</A> won't work by setting
<A HREF="#'fileencoding'">'fileencoding'</A>, use the |<A HREF="editing.html#++enc">++enc</A>| argument. One exception: when
<A HREF="#'fileencodings'">'fileencodings'</A> is empty the value of <A HREF="#'fileencoding'">'fileencoding'</A> is used.
For a new file the global value of <A HREF="#'fileencoding'">'fileencoding'</A> is used.
Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
When the option is set, the value is converted to <A HREF="change.html#lowercase">lowercase</A>. Thus
you can set <A HREF="motion.html#it">it</A> with <A HREF="change.html#uppercase">uppercase</A> values too. '<A HREF="motion.html#_">_</A>' characters are
replaced with '<A HREF="motion.html#-">-</A>'. If a name is recognized from the <A HREF="eval.html#list">list</A> for
<A HREF="#'encoding'">'encoding'</A>, <A HREF="motion.html#it">it</A> is replaced by the standard name. For example
"ISO8859-2" becomes "iso-8859-2".
When this option is set, after starting to edit a file, the <A HREF="#'modified'">'modified'</A>
option is set, because the file would be different when written.
Keep in mind that <A HREF="change.html#changing">changing</A> <A HREF="#'fenc'">'fenc'</A> from a <A HREF="#modeline">modeline</A> happens
AFTER the text has been read, thus <A HREF="motion.html#it">it</A> applies to when the file will be
written. If you <A HREF="diff.html#do">do</A> set <A HREF="#'fenc'">'fenc'</A> in a <A HREF="#modeline">modeline</A>, you might want to set
<A HREF="#'nomodified'">'nomodified'</A> to avoid not being able to "<A HREF="editing.html#:q">:q</A>".
This option can not be changed when <A HREF="#'modifiable'">'modifiable'</A> is off.
*<A NAME="'fe'"></A><B>'fe'</B>*
NOTE: Before version 6.0 this option specified the encoding for the
whole of Vim, this was a mistake. Now use <A HREF="#'encoding'">'encoding'</A> instead. The
old short name was <A HREF="#'fe'">'fe'</A>, which is no longer used.
*<A NAME="'fileencodings'"></A><B>'fileencodings'</B>* *<A NAME="'fencs'"></A><B>'fencs'</B>*
<A HREF="#'fileencodings'">'fileencodings'</A> <A HREF="#'fencs'">'fencs'</A> <A HREF="eval.html#string">string</A> (default: "ucs-bom",
"ucs-bom,utf-8,default,latin1" when
<A HREF="#'encoding'">'encoding'</A> is set to a <A HREF="mbyte.html#Unicode">Unicode</A> value)
global
{only available when compiled with the |<A HREF="various.html#+multi_byte">+multi_byte</A>|
feature}
{not in Vi}
This is a <A HREF="eval.html#list">list</A> of character encodings considered when starting to edit
an existing file. When a file is read, Vim tries to use the first
mentioned character encoding. If an error is detected, the next one
in the <A HREF="eval.html#list">list</A> is tried. When an encoding is found that works,
<A HREF="#'fileencoding'">'fileencoding'</A> is set to <A HREF="motion.html#it">it</A>. If all fail, <A HREF="#'fileencoding'">'fileencoding'</A> is set to
an empty <A HREF="eval.html#string">string</A>, which means the value of <A HREF="#'encoding'">'encoding'</A> is used.
WARNING: Conversion can cause loss of information! When
<A HREF="#'encoding'">'encoding'</A> is "<A HREF="mbyte.html#utf-8">utf-8</A>" (or one of the other <A HREF="mbyte.html#Unicode">Unicode</A> variants)
conversion is most likely done in a way that the reverse
conversion results in the same text. When <A HREF="#'encoding'">'encoding'</A> is not
"<A HREF="mbyte.html#utf-8">utf-8</A>" some non-ASCII characters may be lost! You can use
the |<A HREF="editing.html#++bad">++bad</A>| argument to specify what is done with characters
that can't be converted.
For an empty file or a file with only ASCII characters most encodings
will work and the first entry of <A HREF="#'fileencodings'">'fileencodings'</A> will be used (except
"ucs-bom", which requires the BOM to be present). If you prefer
another encoding use an <A HREF="autocmd.html#BufReadPost">BufReadPost</A> <A HREF="autocmd.html#autocommand">autocommand</A> event to test if your
preferred encoding is to be used. Example:
<B> au BufReadPost * if search('\S', 'w') == 0 |</B>
<B> \ set fenc=iso-2022-jp | endif</B>
This sets <A HREF="#'fileencoding'">'fileencoding'</A> to "iso-2022-jp" if the file does not contain
non-blank characters.
When the |<A HREF="editing.html#++enc">++enc</A>| argument is used then the value of <A HREF="#'fileencodings'">'fileencodings'</A> is
not used.
Note that <A HREF="#'fileencodings'">'fileencodings'</A> is not used for a new file, the global value
of <A HREF="#'fileencoding'">'fileencoding'</A> is used instead. You can set <A HREF="motion.html#it">it</A> with:
<B> :setglobal fenc=iso-8859-2</B>
This means that a non-existing file may get a different encoding than
an empty file.
The special value "ucs-bom" can be used to check for a <A HREF="mbyte.html#Unicode">Unicode</A> BOM
(Byte Order <A HREF="motion.html#Mark">Mark</A>) at the start of the file. It must not be preceded
by "<A HREF="mbyte.html#utf-8">utf-8</A>" or another <A HREF="mbyte.html#Unicode">Unicode</A> encoding for this to work properly.
An entry for an 8-bit encoding (e.g., "latin1") should be the last,
because Vim cannot detect an error, thus the encoding is always
accepted.
The special value "default" can be used for the encoding from the
environment. This is the default value for <A HREF="#'encoding'">'encoding'</A>. It is useful
when <A HREF="#'encoding'">'encoding'</A> is set to "<A HREF="mbyte.html#utf-8">utf-8</A>" and your environment uses a
non-latin1 encoding, such <A HREF="motion.html#as">as</A> <A HREF="russian.html#Russian">Russian</A>.
When <A HREF="#'encoding'">'encoding'</A> is "<A HREF="mbyte.html#utf-8">utf-8</A>" and a file contains an illegal byte
sequence <A HREF="motion.html#it">it</A> won't be recognized <A HREF="motion.html#as">as</A> <A HREF="mbyte.html#UTF-8">UTF-8</A>. You can use the |<A HREF="various.html#8g8">8g8</A>|
command to find the illegal byte sequence.
WRONG VALUES: WHAT'S WRONG:
latin1,utf-8 "latin1" will always be used
utf-8,ucs-bom,latin1 BOM won't be recognized in an <A HREF="mbyte.html#utf-8">utf-8</A>
file
cp1250,latin1 "cp1250" will always be used
If <A HREF="#'fileencodings'">'fileencodings'</A> is empty, <A HREF="#'fileencoding'">'fileencoding'</A> is not modified.
See <A HREF="#'fileencoding'">'fileencoding'</A> for the possible values.
Setting this option does not have an effect until the next time a file
is read.
*<A NAME="'fileformat'"></A><B>'fileformat'</B>* *<A NAME="'ff'"></A><B>'ff'</B>*
<A HREF="#'fileformat'">'fileformat'</A> <A HREF="#'ff'">'ff'</A> <A HREF="eval.html#string">string</A> (MS-DOS, <A HREF="os_win32.html#MS-Windows">MS-Windows</A>, <A HREF="os_os2.html#OS/2">OS/2</A> default: "<A HREF="os_dos.html#dos">dos</A>",
<A HREF="os_unix.html#Unix">Unix</A> default: "<A HREF="os_unix.html#unix">unix</A>",
<A HREF="os_mac.html#Macintosh">Macintosh</A> default: "<A HREF="os_mac.html#mac">mac</A>")
local to buffer
{not in Vi}
This gives the <A HREF="intro.html#<EOL>"><EOL></A> of the current buffer, which is used for
reading/writing the buffer from/to a file:
<A HREF="os_dos.html#dos">dos</A> <A HREF="motion.html#<CR>"><CR></A> <A HREF="motion.html#<NL>"><NL></A>
<A HREF="os_unix.html#unix">unix</A> <A HREF="motion.html#<NL>"><NL></A>
<A HREF="os_mac.html#mac">mac</A> <A HREF="motion.html#<CR>"><CR></A>
When "<A HREF="os_dos.html#dos">dos</A>" is used, <A HREF="starting.html#CTRL-Z">CTRL-Z</A> at the end of a file is ignored.
See |<A HREF="editing.html#file-formats">file-formats</A>| and |<A HREF="insert.html#file-read">file-read</A>|.
For the character encoding of the file see <A HREF="#'fileencoding'">'fileencoding'</A>.
When <A HREF="#'binary'">'binary'</A> is set, the value of <A HREF="#'fileformat'">'fileformat'</A> is ignored, file I/O
works like <A HREF="motion.html#it">it</A> was set to "<A HREF="os_unix.html#unix">unix</A>".
This option is set automatically when starting to edit a file and
<A HREF="#'fileformats'">'fileformats'</A> is not empty and <A HREF="#'binary'">'binary'</A> is off.
When this option is set, after starting to edit a file, the <A HREF="#'modified'">'modified'</A>
option is set, because the file would be different when written.
This option can not be changed when <A HREF="#'modifiable'">'modifiable'</A> is off.
For backwards compatibility: When this option is set to "<A HREF="os_dos.html#dos">dos</A>",
<A HREF="#'textmode'">'textmode'</A> is set, otherwise <A HREF="#'textmode'">'textmode'</A> is reset.
*<A NAME="'fileformats'"></A><B>'fileformats'</B>* *<A NAME="'ffs'"></A><B>'ffs'</B>*
<A HREF="#'fileformats'">'fileformats'</A> <A HREF="#'ffs'">'ffs'</A> <A HREF="eval.html#string">string</A> (default:
Vim+Vi <A HREF="os_msdos.html#MS-DOS">MS-DOS</A>, <A HREF="os_win32.html#MS-Windows">MS-Windows</A> <A HREF="os_os2.html#OS/2">OS/2</A>: "dos,unix",
Vim <A HREF="os_unix.html#Unix">Unix</A>: "unix,dos",
Vim <A HREF="os_mac.html#Mac">Mac</A>: "mac,unix,dos",
<A HREF="intro.html#Vi">Vi</A> Cygwin: "unix,dos",
<A HREF="intro.html#Vi">Vi</A> others: "")
global
{not in Vi}
This gives the end-of-line (<EOL>) formats that will be tried when
starting to edit a new buffer and when reading a file into an existing
buffer:
- When empty, the format defined with <A HREF="#'fileformat'">'fileformat'</A> will be used
always. It is not set automatically.
- When set to one name, that format will be used whenever a new buffer
is opened. <A HREF="#'fileformat'">'fileformat'</A> is set accordingly for that buffer. The
<A HREF="#'fileformats'">'fileformats'</A> name will be used when a file is read into an existing
buffer, no matter what <A HREF="#'fileformat'">'fileformat'</A> for that buffer is set to.
- When more than one name is present, separated by commas, automatic
<A HREF="intro.html#<EOL>"><EOL></A> detection will be done when reading a file. When starting to
edit a file, a check is done for the <A HREF="intro.html#<EOL>"><EOL></A>:
1. If all lines end in <CR><NL>, and <A HREF="#'fileformats'">'fileformats'</A> includes "<A HREF="os_dos.html#dos">dos</A>",
<A HREF="#'fileformat'">'fileformat'</A> is set to "<A HREF="os_dos.html#dos">dos</A>".
2. If a <A HREF="motion.html#<NL>"><NL></A> is found and <A HREF="#'fileformats'">'fileformats'</A> includes "<A HREF="os_unix.html#unix">unix</A>", <A HREF="#'fileformat'">'fileformat'</A>
is set to "<A HREF="os_unix.html#unix">unix</A>". Note that when a <A HREF="motion.html#<NL>"><NL></A> is found without a
preceding <A HREF="motion.html#<CR>"><CR></A>, "<A HREF="os_unix.html#unix">unix</A>" is preferred over "<A HREF="os_dos.html#dos">dos</A>".
3. If <A HREF="#'fileformat'">'fileformat'</A> has not yet been set, and if a <A HREF="motion.html#<CR>"><CR></A> is found, and
if <A HREF="#'fileformats'">'fileformats'</A> includes "<A HREF="os_mac.html#mac">mac</A>", <A HREF="#'fileformat'">'fileformat'</A> is set to "<A HREF="os_mac.html#mac">mac</A>".
This means that "<A HREF="os_mac.html#mac">mac</A>" is only chosen when:
"<A HREF="os_unix.html#unix">unix</A>" is not present or no <A HREF="motion.html#<NL>"><NL></A> is found in the file, and
"<A HREF="os_dos.html#dos">dos</A>" is not present or no <CR><NL> is found in the file.
Except: if "<A HREF="os_unix.html#unix">unix</A>" was chosen, but there is a <A HREF="motion.html#<CR>"><CR></A> before
the first <A HREF="motion.html#<NL>"><NL></A>, and there appear to be more <CR>s than <NL>s in
the first few lines, "<A HREF="os_mac.html#mac">mac</A>" is used.
4. If <A HREF="#'fileformat'">'fileformat'</A> is still not set, the first name from
<A HREF="#'fileformats'">'fileformats'</A> is used.
When reading a file into an existing buffer, the same is done, but
this happens like <A HREF="#'fileformat'">'fileformat'</A> has been set appropriately for that
file only, the option is not changed.
When <A HREF="#'binary'">'binary'</A> is set, the value of <A HREF="#'fileformats'">'fileformats'</A> is not used.
When Vim starts up with an empty buffer the first item is used. You
can overrule this by setting <A HREF="#'fileformat'">'fileformat'</A> in your <A HREF="starting.html#.vimrc">.vimrc</A>.
For systems with a Dos-like <A HREF="intro.html#<EOL>"><EOL></A> (<CR><NL>), when reading files that
are ":source"ed and for <A HREF="starting.html#vimrc">vimrc</A> files, automatic <A HREF="intro.html#<EOL>"><EOL></A> detection may be
done:
- When <A HREF="#'fileformats'">'fileformats'</A> is empty, there is no automatic detection. Dos
format will be used.
- When <A HREF="#'fileformats'">'fileformats'</A> is set to one or more names, automatic detection
is done. This is based on the first <A HREF="motion.html#<NL>"><NL></A> in the file: If there is a
<A HREF="motion.html#<CR>"><CR></A> in front of <A HREF="motion.html#it">it</A>, Dos format is used, otherwise <A HREF="os_unix.html#Unix">Unix</A> format is
used.
Also see |<A HREF="editing.html#file-formats">file-formats</A>|.
For backwards compatibility: When this option is set to an empty
<A HREF="eval.html#string">string</A> or one format (no comma is included), <A HREF="#'textauto'">'textauto'</A> is reset,
otherwise <A HREF="#'textauto'">'textauto'</A> is set.
NOTE: This option is set to the <A HREF="intro.html#Vi">Vi</A> default value when <A HREF="#'compatible'">'compatible'</A> is
set and to the Vim default value when <A HREF="#'compatible'">'compatible'</A> is reset.
*<A NAME="'fileignorecase'"></A><B>'fileignorecase'</B>* *<A NAME="'fic'"></A><B>'fic'</B>* *<A NAME="'nofileignorecase'"></A><B>'nofileignorecase'</B>* *<A NAME="'nofic'"></A><B>'nofic'</B>*
<A HREF="#'fileignorecase'">'fileignorecase'</A> <A HREF="#'fic'">'fic'</A> <A HREF="#boolean">boolean</A> (default on for systems where <A HREF="change.html#case">case</A> in file
names is normally ignored)
global
{not in Vi}
When set <A HREF="change.html#case">case</A> is ignored when using file names and directories.
See <A HREF="#'wildignorecase'">'wildignorecase'</A> for only ignoring <A HREF="change.html#case">case</A> when doing completion.
*<A NAME="'filetype'"></A><B>'filetype'</B>* *<A NAME="'ft'"></A><B>'ft'</B>*
<A HREF="#'filetype'">'filetype'</A> <A HREF="#'ft'">'ft'</A> <A HREF="eval.html#string">string</A> (default: "")
local to buffer
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+autocmd">+autocmd</A>|
feature}
When this option is set, the <A HREF="autocmd.html#FileType">FileType</A> <A HREF="autocmd.html#autocommand">autocommand</A> event is triggered.
All autocommands that match with the value of this option will be
executed. Thus the value of <A HREF="#'filetype'">'filetype'</A> is used in place of the file
name.
Otherwise this option does not always reflect the current file type.
This option is normally set when the file type is detected. To enable
this use the ":filetype on" command. |<A HREF="filetype.html#:filetype">:filetype</A>|
Setting this option to a different value is most useful in a <A HREF="#modeline">modeline</A>,
for a file for which the file type is not automatically recognized.
Example, for in an IDL file:
<B><FONT COLOR="PURPLE"> /* vim: set filetype=idl : */ </FONT></B>
|<A HREF="autocmd.html#FileType">FileType</A>| |<A HREF="filetype.html#filetypes">filetypes</A>|
When a dot appears in the value then this separates two <A HREF="filetype.html#filetype">filetype</A>
names. Example:
<B><FONT COLOR="PURPLE"> /* vim: set filetype=c.doxygen : */ </FONT></B>
This will use the "<A HREF="change.html#c">c</A>" <A HREF="filetype.html#filetype">filetype</A> first, then the "doxygen" <A HREF="filetype.html#filetype">filetype</A>.
This works both for <A HREF="filetype.html#filetype">filetype</A> plugins and for <A HREF="syntax.html#syntax">syntax</A> files. More than
one dot may appear.
This option is not copied to another buffer, independent of the '<A HREF="change.html#s">s</A>' or
'<A HREF="change.html#S">S</A>' flag in <A HREF="#'cpoptions'">'cpoptions'</A>.
Only normal file name characters can be used, "/\*?[|<>" are illegal.
*<A NAME="'fillchars'"></A><B>'fillchars'</B>* *<A NAME="'fcs'"></A><B>'fcs'</B>*
<A HREF="#'fillchars'">'fillchars'</A> <A HREF="#'fcs'">'fcs'</A> <A HREF="eval.html#string">string</A> (default "vert:YXXY,fold:-")
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+windows">+windows</A>|
and |<A HREF="various.html#+folding">+folding</A>| features}
Characters to fill the statuslines and vertical separators.
It is a comma separated <A HREF="eval.html#list">list</A> of items:
<B><FONT COLOR="PURPLE"> item default Used for </FONT></B>
stl:c '' '' or '<A HREF="motion.html#^">^</A>' statusline of the current <A HREF="windows.html#window">window</A>
stlnc:c '' '' or '<A HREF="change.html#=">=</A>' statusline of the non-current <A HREF="windows.html#windows">windows</A>
vert:c '|' vertical separators |<A HREF="windows.html#:vsplit">:vsplit</A>|
fold:c '<A HREF="motion.html#-">-</A>' filling <A HREF="#'foldtext'">'foldtext'</A>
diff:c '<A HREF="motion.html#-">-</A>' deleted lines of the <A HREF="#'diff'">'diff'</A> option
Any one that is omitted will fall back to the default. For "stl" and
"stlnc" the space will be used when there is highlighting, '<A HREF="motion.html#^">^</A>' or '<A HREF="change.html#=">=</A>'
otherwise.
Example:
<B> :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-</B>
This is similar to the default, except that these characters will also
be used when there is highlighting.
for "stl" and "stlnc" only single-byte values are supported.
The highlighting used for these items:
<B><FONT COLOR="PURPLE"> item highlight group </FONT></B>
stl:c StatusLine |<A HREF="syntax.html#hl-StatusLine">hl-StatusLine</A>|
stlnc:c StatusLineNC |<A HREF="syntax.html#hl-StatusLineNC">hl-StatusLineNC</A>|
vert:c VertSplit |<A HREF="syntax.html#hl-VertSplit">hl-VertSplit</A>|
fold:c Folded |<A HREF="syntax.html#hl-Folded">hl-Folded</A>|
diff:c DiffDelete |<A HREF="syntax.html#hl-DiffDelete">hl-DiffDelete</A>|
*<A NAME="'fixendofline'"></A><B>'fixendofline'</B>* *<A NAME="'fixeol'"></A><B>'fixeol'</B>* *<A NAME="'nofixendofline'"></A><B>'nofixendofline'</B>* *<A NAME="'nofixeol'"></A><B>'nofixeol'</B>*
<A HREF="#'fixendofline'">'fixendofline'</A> <A HREF="#'fixeol'">'fixeol'</A> <A HREF="#boolean">boolean</A> (default on)
local to buffer
{not in Vi}
When <A HREF="editing.html#writing">writing</A> a file and this option is on, <A HREF="intro.html#<EOL>"><EOL></A> at the end of file
will be restored if missing. Turn this option off if you want to
preserve the situation from the original file.
When the <A HREF="#'binary'">'binary'</A> option is set the value of this option doesn't
matter.
See the <A HREF="#'endofline'">'endofline'</A> option.
*<A NAME="'fkmap'"></A><B>'fkmap'</B>* *<A NAME="'fk'"></A><B>'fk'</B>* *<A NAME="'nofkmap'"></A><B>'nofkmap'</B>* *<A NAME="'nofk'"></A><B>'nofk'</B>*
<A HREF="#'fkmap'">'fkmap'</A> <A HREF="#'fk'">'fk'</A> <A HREF="#boolean">boolean</A> (default off) *<A NAME="E198"></A><B>E198</B>*
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+rightleft">+rightleft</A>|
feature}
When on, the keyboard is mapped for the <A HREF="farsi.html#Farsi">Farsi</A> character set.
Normally you would set <A HREF="#'allowrevins'">'allowrevins'</A> and use CTRL-_ in insert mode to
toggle this option |<A HREF="insert.html#i_CTRL-_">i_CTRL-_</A>|. See |<A HREF="farsi.html">farsi.txt</A>|.
*<A NAME="'foldclose'"></A><B>'foldclose'</B>* *<A NAME="'fcl'"></A><B>'fcl'</B>*
<A HREF="#'foldclose'">'foldclose'</A> <A HREF="#'fcl'">'fcl'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+folding">+folding</A>|
feature}
When set to "all", a fold is closed when the cursor isn't in <A HREF="motion.html#it">it</A> and
its level is higher than <A HREF="#'foldlevel'">'foldlevel'</A>. Useful if you want <A HREF="fold.html#folds">folds</A> to
automatically close when moving out of them.
*<A NAME="'foldcolumn'"></A><B>'foldcolumn'</B>* *<A NAME="'fdc'"></A><B>'fdc'</B>*
<A HREF="#'foldcolumn'">'foldcolumn'</A> <A HREF="#'fdc'">'fdc'</A> number (default 0)
local to <A HREF="windows.html#window">window</A>
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+folding">+folding</A>|
feature}
When non-zero, a column with the specified width is shown at the side
of the <A HREF="windows.html#window">window</A> which indicates open and closed <A HREF="fold.html#folds">folds</A>. The maximum
value is 12.
See |<A HREF="fold.html#folding">folding</A>|.
*<A NAME="'foldenable'"></A><B>'foldenable'</B>* *<A NAME="'fen'"></A><B>'fen'</B>* *<A NAME="'nofoldenable'"></A><B>'nofoldenable'</B>* *<A NAME="'nofen'"></A><B>'nofen'</B>*
<A HREF="#'foldenable'">'foldenable'</A> <A HREF="#'fen'">'fen'</A> <A HREF="#boolean">boolean</A> (default on)
local to <A HREF="windows.html#window">window</A>
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+folding">+folding</A>|
feature}
When off, all <A HREF="fold.html#folds">folds</A> are open. This option can be used to quickly
switch between showing all text unfolded and viewing the text with
<A HREF="fold.html#folds">folds</A> (including manually opened or closed <A HREF="fold.html#folds">folds</A>). It can be toggled
with the |<A HREF="fold.html#zi">zi</A>| command. The <A HREF="#'foldcolumn'">'foldcolumn'</A> will remain blank when
<A HREF="#'foldenable'">'foldenable'</A> is off.
This option is set by commands that create a new fold or close a fold.
See |<A HREF="fold.html#folding">folding</A>|.
*<A NAME="'foldexpr'"></A><B>'foldexpr'</B>* *<A NAME="'fde'"></A><B>'fde'</B>*
<A HREF="#'foldexpr'">'foldexpr'</A> <A HREF="#'fde'">'fde'</A> <A HREF="eval.html#string">string</A> (default: "<A HREF="motion.html#0">0</A>")
local to <A HREF="windows.html#window">window</A>
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+folding">+folding</A>|
or |<A HREF="various.html#+eval">+eval</A>| features}
The <A HREF="eval.html#expression">expression</A> used for when <A HREF="#'foldmethod'">'foldmethod'</A> is "<A HREF="eval.html#expr">expr</A>". It is evaluated
for each line to obtain its fold level. See |<A HREF="fold.html#fold-expr">fold-expr</A>|.
The <A HREF="eval.html#expression">expression</A> will be evaluated in the |<A HREF="eval.html#sandbox">sandbox</A>| if set from a
<A HREF="#modeline">modeline</A>, see |<A HREF="eval.html#sandbox-option">sandbox-option</A>|.
This option can't be set from a |<A HREF="#modeline">modeline</A>| when the <A HREF="#'diff'">'diff'</A> option is
on.
It is not allowed to change text or jump to another <A HREF="windows.html#window">window</A> while
evaluating <A HREF="#'foldexpr'">'foldexpr'</A> |<A HREF="eval.html#textlock">textlock</A>|.
*<A NAME="'foldignore'"></A><B>'foldignore'</B>* *<A NAME="'fdi'"></A><B>'fdi'</B>*
<A HREF="#'foldignore'">'foldignore'</A> <A HREF="#'fdi'">'fdi'</A> <A HREF="eval.html#string">string</A> (default: "<A HREF="pattern.html##">#</A>")
local to <A HREF="windows.html#window">window</A>
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+folding">+folding</A>|
feature}
Used only when <A HREF="#'foldmethod'">'foldmethod'</A> is "indent". Lines starting with
characters in <A HREF="#'foldignore'">'foldignore'</A> will get their fold level from surrounding
lines. White space is skipped before checking for this character.
The default "<A HREF="pattern.html##">#</A>" works well for C programs. See |<A HREF="fold.html#fold-indent">fold-indent</A>|.
*<A NAME="'foldlevel'"></A><B>'foldlevel'</B>* *<A NAME="'fdl'"></A><B>'fdl'</B>*
<A HREF="#'foldlevel'">'foldlevel'</A> <A HREF="#'fdl'">'fdl'</A> number (default: 0)
local to <A HREF="windows.html#window">window</A>
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+folding">+folding</A>|
feature}
Sets the fold level: Folds with a higher level will be closed.
Setting this option to zero will close all <A HREF="fold.html#folds">folds</A>. Higher numbers will
close fewer <A HREF="fold.html#folds">folds</A>.
This option is set by commands like |<A HREF="fold.html#zm">zm</A>|, |<A HREF="fold.html#zM">zM</A>| and |<A HREF="fold.html#zR">zR</A>|.
See |<A HREF="fold.html#fold-foldlevel">fold-foldlevel</A>|.
*<A NAME="'foldlevelstart'"></A><B>'foldlevelstart'</B>* *<A NAME="'fdls'"></A><B>'fdls'</B>*
<A HREF="#'foldlevelstart'">'foldlevelstart'</A> <A HREF="#'fdls'">'fdls'</A> number (default: -1)
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+folding">+folding</A>|
feature}
Sets <A HREF="#'foldlevel'">'foldlevel'</A> when starting to edit another buffer in a <A HREF="windows.html#window">window</A>.
Useful to always start editing with all <A HREF="fold.html#folds">folds</A> closed (value zero),
some <A HREF="fold.html#folds">folds</A> closed (one) or no <A HREF="fold.html#folds">folds</A> closed (99).
This is done before reading any <A HREF="#modeline">modeline</A>, thus a setting in a <A HREF="#modeline">modeline</A>
overrules this option. Starting to edit a file for |<A HREF="diff.html#diff-mode">diff-mode</A>| also
ignores this option and closes all <A HREF="fold.html#folds">folds</A>.
It is also done before <A HREF="autocmd.html#BufReadPre">BufReadPre</A> autocommands, to allow an autocmd to
overrule the <A HREF="#'foldlevel'">'foldlevel'</A> value for specific files.
When the value is negative, <A HREF="motion.html#it">it</A> is not used.
*<A NAME="'foldmarker'"></A><B>'foldmarker'</B>* *<A NAME="'fmr'"></A><B>'fmr'</B>* *<A NAME="E536"></A><B>E536</B>*
<A HREF="#'foldmarker'">'foldmarker'</A> <A HREF="#'fmr'">'fmr'</A> <A HREF="eval.html#string">string</A> (default: "{{{,}}}")
local to <A HREF="windows.html#window">window</A>
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+folding">+folding</A>|
feature}
The start and end marker used when <A HREF="#'foldmethod'">'foldmethod'</A> is "marker". There
must be one comma, which separates the start and end marker. The
marker is a literal <A HREF="eval.html#string">string</A> (a regular <A HREF="eval.html#expression">expression</A> would be too slow).
See |<A HREF="fold.html#fold-marker">fold-marker</A>|.
*<A NAME="'foldmethod'"></A><B>'foldmethod'</B>* *<A NAME="'fdm'"></A><B>'fdm'</B>*
<A HREF="#'foldmethod'">'foldmethod'</A> <A HREF="#'fdm'">'fdm'</A> <A HREF="eval.html#string">string</A> (default: "manual")
local to <A HREF="windows.html#window">window</A>
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+folding">+folding</A>|
feature}
The kind of <A HREF="fold.html#folding">folding</A> used for the current <A HREF="windows.html#window">window</A>. Possible values:
|<A HREF="fold.html#fold-manual">fold-manual</A>| manual Folds are created manually.
|<A HREF="fold.html#fold-indent">fold-indent</A>| indent Lines with equal indent form a fold.
|<A HREF="fold.html#fold-expr">fold-expr</A>| expr <A HREF="#'foldexpr'">'foldexpr'</A> gives the fold level of a line.
|<A HREF="fold.html#fold-marker">fold-marker</A>| marker Markers are used to specify <A HREF="fold.html#folds">folds</A>.
|<A HREF="fold.html#fold-syntax">fold-syntax</A>| syntax <A HREF="autocmd.html#Syntax">Syntax</A> highlighting items specify <A HREF="fold.html#folds">folds</A>.
|<A HREF="fold.html#fold-diff">fold-diff</A>| diff Fold text that is not changed.
*<A NAME="'foldminlines'"></A><B>'foldminlines'</B>* *<A NAME="'fml'"></A><B>'fml'</B>*
<A HREF="#'foldminlines'">'foldminlines'</A> <A HREF="#'fml'">'fml'</A> number (default: 1)
local to <A HREF="windows.html#window">window</A>
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+folding">+folding</A>|
feature}
Sets the number of screen lines above which a fold can be displayed
closed. Also for manually closed <A HREF="fold.html#folds">folds</A>. With the default value of
one a fold can only be closed if <A HREF="motion.html#it">it</A> takes up two or more screen lines.
Set to zero to be able to close <A HREF="fold.html#folds">folds</A> of just one screen line.
Note that this only has an effect on what is displayed. After using
"<A HREF="fold.html#zc">zc</A>" to close a fold, which is displayed open because it's smaller
than <A HREF="#'foldminlines'">'foldminlines'</A>, a following "<A HREF="fold.html#zc">zc</A>" may close a containing fold.
*<A NAME="'foldnestmax'"></A><B>'foldnestmax'</B>* *<A NAME="'fdn'"></A><B>'fdn'</B>*
<A HREF="#'foldnestmax'">'foldnestmax'</A> <A HREF="#'fdn'">'fdn'</A> number (default: 20)
local to <A HREF="windows.html#window">window</A>
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+folding">+folding</A>|
feature}
Sets the maximum nesting of <A HREF="fold.html#folds">folds</A> for the "indent" and "<A HREF="syntax.html#syntax">syntax</A>"
methods. This avoids that too many <A HREF="fold.html#folds">folds</A> will be created. Using more
than 20 doesn't work, because the internal limit is 20.
*<A NAME="'foldopen'"></A><B>'foldopen'</B>* *<A NAME="'fdo'"></A><B>'fdo'</B>*
<A HREF="#'foldopen'">'foldopen'</A> <A HREF="#'fdo'">'fdo'</A> <A HREF="eval.html#string">string</A> (default: "block,hor,mark,percent,quickfix,
search,tag,undo")
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+folding">+folding</A>|
feature}
Specifies for which type of commands <A HREF="fold.html#folds">folds</A> will be opened, if the
command moves the cursor into a closed fold. It is a comma separated
<A HREF="eval.html#list">list</A> of items.
NOTE: When the command is part of a <A HREF="map.html#mapping">mapping</A> this option is not used.
Add the |<A HREF="fold.html#zv">zv</A>| command to the <A HREF="map.html#mapping">mapping</A> to get the same effect.
(rationale: the <A HREF="map.html#mapping">mapping</A> may want to <A HREF="intro.html#control">control</A> opening <A HREF="fold.html#folds">folds</A> itself)
<B><FONT COLOR="PURPLE"> item commands </FONT></B>
all any
block "<A HREF="motion.html#(">(</A>", "<A HREF="motion.html#{">{</A>", "<A HREF="motion.html#[[">[[</A>", "<A HREF="motion.html#[{">[{</A>", etc.
hor horizontal movements: "<A HREF="motion.html#l">l</A>", "<A HREF="motion.html#w">w</A>", "fx", etc.
insert any command in <A HREF="insert.html#Insert">Insert</A> mode
jump far jumps: "<A HREF="motion.html#G">G</A>", "<A HREF="motion.html#gg">gg</A>", etc.
<A HREF="motion.html#mark">mark</A> jumping to a <A HREF="motion.html#mark">mark</A>: "'m", <A HREF="motion.html#CTRL-O">CTRL-O</A>, etc.
percent "<A HREF="motion.html#%">%</A>"
<A HREF="quickfix.html#quickfix">quickfix</A> "<A HREF="quickfix.html#:cn">:cn</A>", ":crew", "<A HREF="quickfix.html#:make">:make</A>", etc.
search search for a <A HREF="pattern.html#pattern">pattern</A>: "<A HREF="pattern.html#/">/</A>", "<A HREF="pattern.html#n">n</A>", "*", "<A HREF="pattern.html#gd">gd</A>", etc.
(not for a search <A HREF="pattern.html#pattern">pattern</A> in a "<A HREF="cmdline.html#:">:</A>" command)
Also for |<A HREF="spell.html#[s">[s</A>| and |<A HREF="spell.html#]s">]s</A>|.
<A HREF="tagsrch.html#tag">tag</A> jumping to a <A HREF="tagsrch.html#tag">tag</A>: "<A HREF="tagsrch.html#:ta">:ta</A>", <A HREF="tagsrch.html#CTRL-T">CTRL-T</A>, etc.
<A HREF="undo.html#undo">undo</A> <A HREF="undo.html#undo">undo</A> or <A HREF="undo.html#redo">redo</A>: "<A HREF="undo.html#u">u</A>" and <A HREF="undo.html#CTRL-R">CTRL-R</A>
When a <A HREF="intro.html#movement">movement</A> command is used for an <A HREF="motion.html#operator">operator</A> (e.g., "<A HREF="change.html#dl">dl</A>" or "y%")
this option is not used. This means the <A HREF="motion.html#operator">operator</A> will include the
whole closed fold.
Note that vertical movements are not here, because <A HREF="motion.html#it">it</A> would make <A HREF="motion.html#it">it</A>
very difficult to move onto a closed fold.
In insert mode the <A HREF="fold.html#folds">folds</A> containing the cursor will always be open
when text is inserted.
To close <A HREF="fold.html#folds">folds</A> you can re-apply <A HREF="#'foldlevel'">'foldlevel'</A> with the |<A HREF="fold.html#zx">zx</A>| command or
set the <A HREF="#'foldclose'">'foldclose'</A> option to "all".
*<A NAME="'foldtext'"></A><B>'foldtext'</B>* *<A NAME="'fdt'"></A><B>'fdt'</B>*
<A HREF="#'foldtext'">'foldtext'</A> <A HREF="#'fdt'">'fdt'</A> <A HREF="eval.html#string">string</A> (default: "<A HREF="eval.html#foldtext()">foldtext()</A>")
local to <A HREF="windows.html#window">window</A>
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+folding">+folding</A>|
feature}
An <A HREF="eval.html#expression">expression</A> which is used to specify the text displayed for a closed
fold. See |<A HREF="fold.html#fold-foldtext">fold-foldtext</A>|.
The <A HREF="eval.html#expression">expression</A> will be evaluated in the |<A HREF="eval.html#sandbox">sandbox</A>| if set from a
<A HREF="#modeline">modeline</A>, see |<A HREF="eval.html#sandbox-option">sandbox-option</A>|.
It is not allowed to change text or jump to another <A HREF="windows.html#window">window</A> while
evaluating <A HREF="#'foldtext'">'foldtext'</A> |<A HREF="eval.html#textlock">textlock</A>|.
*<A NAME="'formatexpr'"></A><B>'formatexpr'</B>* *<A NAME="'fex'"></A><B>'fex'</B>*
<A HREF="#'formatexpr'">'formatexpr'</A> <A HREF="#'fex'">'fex'</A> <A HREF="eval.html#string">string</A> (default "")
local to buffer
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+eval">+eval</A>|
feature}
Expression which is evaluated to format a range of lines for the |<A HREF="change.html#gq">gq</A>|
<A HREF="motion.html#operator">operator</A> or automatic <A HREF="change.html#formatting">formatting</A> (see <A HREF="#'formatoptions'">'formatoptions'</A>). When this
option is empty <A HREF="#'formatprg'">'formatprg'</A> is used.
The |<A HREF="eval.html#v:lnum">v:lnum</A>| variable holds the first line to be formatted.
The |<A HREF="eval.html#v:count">v:count</A>| variable holds the number of lines to be formatted.
The |<A HREF="eval.html#v:char">v:char</A>| variable holds the character that is going to be
inserted if the <A HREF="eval.html#expression">expression</A> is being evaluated due to
automatic <A HREF="change.html#formatting">formatting</A>. This can be empty. Don't insert
<A HREF="motion.html#it">it</A> yet!
Example:
<B> :set formatexpr=mylang#Format()</B>
This will invoke the mylang#Format() function in the
autoload/mylang.vim file in <A HREF="#'runtimepath'">'runtimepath'</A>. |<A HREF="eval.html#autoload">autoload</A>|
The <A HREF="eval.html#expression">expression</A> is also evaluated when <A HREF="#'textwidth'">'textwidth'</A> is set and adding
text beyond that limit. This happens under the same conditions <A HREF="motion.html#as">as</A>
when internal <A HREF="change.html#formatting">formatting</A> is used. Make sure the cursor is kept in the
same spot relative to the text then! The |<A HREF="eval.html#mode()">mode()</A>| function will
return "<A HREF="insert.html#i">i</A>" or "<A HREF="change.html#R">R</A>" in this situation.
When the <A HREF="eval.html#expression">expression</A> evaluates to non-zero Vim will fall back to using
the internal format mechanism.
The <A HREF="eval.html#expression">expression</A> will be evaluated in the |<A HREF="eval.html#sandbox">sandbox</A>| when set from a
<A HREF="#modeline">modeline</A>, see |<A HREF="eval.html#sandbox-option">sandbox-option</A>|. That stops the option from working,
since <A HREF="change.html#changing">changing</A> the buffer text is not allowed.
NOTE: This option is set to "" when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'formatoptions'"></A><B>'formatoptions'</B>* *<A NAME="'fo'"></A><B>'fo'</B>*
<A HREF="#'formatoptions'">'formatoptions'</A> <A HREF="#'fo'">'fo'</A> <A HREF="eval.html#string">string</A> (Vim default: "tcq", <A HREF="intro.html#Vi">Vi</A> default: "vt")
local to buffer
{not in Vi}
This is a sequence of letters which describes how automatic
<A HREF="change.html#formatting">formatting</A> is to be done. See |<A HREF="change.html#fo-table">fo-table</A>|. When the <A HREF="#'paste'">'paste'</A> option is
on, no <A HREF="change.html#formatting">formatting</A> is done (like <A HREF="#'formatoptions'">'formatoptions'</A> is empty). Commas can
be inserted for readability.
To avoid problems with flags that are added in the future, use the
"+=" and "-=" feature of "<A HREF="#:set">:set</A>" |<A HREF="#add-option-flags">add-option-flags</A>|.
NOTE: This option is set to the <A HREF="intro.html#Vi">Vi</A> default value when <A HREF="#'compatible'">'compatible'</A> is
set and to the Vim default value when <A HREF="#'compatible'">'compatible'</A> is reset.
*<A NAME="'formatlistpat'"></A><B>'formatlistpat'</B>* *<A NAME="'flp'"></A><B>'flp'</B>*
<A HREF="#'formatlistpat'">'formatlistpat'</A> <A HREF="#'flp'">'flp'</A> <A HREF="eval.html#string">string</A> (default: "^\s*\d\+[\]:.)}\t ]\s*")
local to buffer
{not in Vi}
A <A HREF="pattern.html#pattern">pattern</A> that is used to recognize a <A HREF="eval.html#list">list</A> header. This is used for
the "<A HREF="pattern.html#n">n</A>" flag in <A HREF="#'formatoptions'">'formatoptions'</A>.
The <A HREF="pattern.html#pattern">pattern</A> must match exactly the text that will be the indent for
the line below <A HREF="motion.html#it">it</A>. You can use |<A HREF="pattern.html#/\ze">/\ze</A>| to <A HREF="motion.html#mark">mark</A> the end of the match
while still checking more characters. There must be a character
following the <A HREF="pattern.html#pattern">pattern</A>, when <A HREF="motion.html#it">it</A> matches the whole line <A HREF="motion.html#it">it</A> is handled
like there is no match.
The default recognizes a number, followed by an optional punctuation
character and white space.
*<A NAME="'formatprg'"></A><B>'formatprg'</B>* *<A NAME="'fp'"></A><B>'fp'</B>*
<A HREF="#'formatprg'">'formatprg'</A> <A HREF="#'fp'">'fp'</A> <A HREF="eval.html#string">string</A> (default "")
global or local to buffer |<A HREF="#global-local">global-local</A>|
{not in Vi}
The name of an external program that will be used to format the lines
selected with the |<A HREF="change.html#gq">gq</A>| <A HREF="motion.html#operator">operator</A>. The program must take the input on
stdin and produce the output on stdout. The <A HREF="os_unix.html#Unix">Unix</A> program "fmt" is
such a program.
If the <A HREF="#'formatexpr'">'formatexpr'</A> option is not empty <A HREF="motion.html#it">it</A> will be used instead.
Otherwise, if <A HREF="#'formatprg'">'formatprg'</A> option is an empty <A HREF="eval.html#string">string</A>, the internal
format function will be used |<A HREF="indent.html#C-indenting">C-indenting</A>|.
Environment <A HREF="eval.html#variables">variables</A> are expanded |<A HREF="#:set_env">:set_env</A>|. See |<A HREF="#option-backslash">option-backslash</A>|
about including spaces and backslashes.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'fsync'"></A><B>'fsync'</B>* *<A NAME="'fs'"></A><B>'fs'</B>* *<A NAME="'nofsync'"></A><B>'nofsync'</B>* *<A NAME="'nofs'"></A><B>'nofs'</B>*
<A HREF="#'fsync'">'fsync'</A> <A HREF="#'fs'">'fs'</A> <A HREF="#boolean">boolean</A> (default on)
global
{not in Vi}
When on, the library function fsync() will be called after <A HREF="editing.html#writing">writing</A> a
file. This will flush a file to disk, ensuring that <A HREF="motion.html#it">it</A> is safely
written even on filesystems which <A HREF="diff.html#do">do</A> metadata-only journaling. This
will force the harddrive to spin up on Linux systems running in laptop
mode, so <A HREF="motion.html#it">it</A> may be undesirable in some situations. Be warned that
turning this off increases the chances of data loss after a crash. On
systems without an fsync() implementation, this variable is always
off.
Also see <A HREF="#'swapsync'">'swapsync'</A> for controlling fsync() on swap files.
<A HREF="#'fsync'">'fsync'</A> also applies to |<A HREF="eval.html#writefile()">writefile()</A>|, unless a flag is used to
overrule <A HREF="motion.html#it">it</A>.
*<A NAME="'gdefault'"></A><B>'gdefault'</B>* *<A NAME="'gd'"></A><B>'gd'</B>* *<A NAME="'nogdefault'"></A><B>'nogdefault'</B>* *<A NAME="'nogd'"></A><B>'nogd'</B>*
<A HREF="#'gdefault'">'gdefault'</A> <A HREF="#'gd'">'gd'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
When on, the "<A HREF="change.html#:substitute">:substitute</A>" flag '<A HREF="index.html#g">g</A>' is default on. This means that
all matches in a line are substituted instead of one. When a '<A HREF="index.html#g">g</A>' flag
is given to a "<A HREF="change.html#:substitute">:substitute</A>" command, this will toggle the substitution
of all or one match. See |<A HREF="change.html#complex-change">complex-change</A>|.
<B><FONT COLOR="PURPLE"> command 'gdefault' on 'gdefault' off </FONT></B>
:s/// subst. all subst. one
:s///g subst. one subst. all
:s///gg subst. all subst. one
NOTE: This option is reset when <A HREF="#'compatible'">'compatible'</A> is set.
DEPRECATED: Setting this option may break plugins that are not aware
of this option. Also, many users get confused that adding the /g flag
has the opposite effect of that <A HREF="motion.html#it">it</A> normally does.
*<A NAME="'grepformat'"></A><B>'grepformat'</B>* *<A NAME="'gfm'"></A><B>'gfm'</B>*
<A HREF="#'grepformat'">'grepformat'</A> <A HREF="#'gfm'">'gfm'</A> <A HREF="eval.html#string">string</A> (default "%f:%l:%m,%f:%l%m,%f %l%m")
global
{not in Vi}
Format to recognize for the "<A HREF="quickfix.html#:grep">:grep</A>" command output.
This is a scanf-like <A HREF="eval.html#string">string</A> that uses the same format <A HREF="motion.html#as">as</A> the
<A HREF="#'errorformat'">'errorformat'</A> option: see |<A HREF="quickfix.html#errorformat">errorformat</A>|.
*<A NAME="'grepprg'"></A><B>'grepprg'</B>* *<A NAME="'gp'"></A><B>'gp'</B>*
<A HREF="#'grepprg'">'grepprg'</A> <A HREF="#'gp'">'gp'</A> <A HREF="eval.html#string">string</A> (default "<A HREF="quickfix.html#grep">grep</A> <A HREF="starting.html#-n">-n</A> "<A HREF="motion.html#,">,</A>
<A HREF="os_unix.html#Unix">Unix</A>: "<A HREF="quickfix.html#grep">grep</A> <A HREF="starting.html#-n">-n</A> $* /dev/null",
<A HREF="os_win32.html#Win32">Win32</A>: "findstr /n" or "<A HREF="quickfix.html#grep">grep</A> -n",
<A HREF="os_vms.html#VMS">VMS</A>: "SEARCH/NUMBERS "<A HREF="motion.html#)">)</A>
global or local to buffer |<A HREF="#global-local">global-local</A>|
{not in Vi}
Program to use for the |<A HREF="quickfix.html#:grep">:grep</A>| command. This option may contain '<A HREF="motion.html#%">%</A>'
and '<A HREF="pattern.html##">#</A>' characters, which are expanded like when used in a command-
line. The placeholder "$*" is allowed to specify where the arguments
will be included. Environment <A HREF="eval.html#variables">variables</A> are expanded |<A HREF="#:set_env">:set_env</A>|. See
|<A HREF="#option-backslash">option-backslash</A>| about including spaces and backslashes.
When your "<A HREF="quickfix.html#grep">grep</A>" accepts the "<A HREF="starting.html#-H">-H</A>" argument, use this to make "<A HREF="quickfix.html#:grep">:grep</A>"
also work well with a single file:
<B> :set grepprg=grep\ -nH</B>
<A HREF="eval.html#Special">Special</A> value: When <A HREF="#'grepprg'">'grepprg'</A> is set to "internal" the |<A HREF="quickfix.html#:grep">:grep</A>| command
works like |<A HREF="quickfix.html#:vimgrep">:vimgrep</A>|, |<A HREF="quickfix.html#:lgrep">:lgrep</A>| like |<A HREF="quickfix.html#:lvimgrep">:lvimgrep</A>|, |<A HREF="quickfix.html#:grepadd">:grepadd</A>| like
|<A HREF="quickfix.html#:vimgrepadd">:vimgrepadd</A>| and |<A HREF="quickfix.html#:lgrepadd">:lgrepadd</A>| like |<A HREF="quickfix.html#:lvimgrepadd">:lvimgrepadd</A>|.
See also the section |<A HREF="quickfix.html#:make_makeprg">:make_makeprg</A>|, since most of the comments there
apply equally to <A HREF="#'grepprg'">'grepprg'</A>.
For <A HREF="os_win32.html#Win32">Win32</A>, the default is "findstr /n" if "findstr.exe" can be found,
otherwise it's "<A HREF="quickfix.html#grep">grep</A> -n".
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'guicursor'"></A><B>'guicursor'</B>* *<A NAME="'gcr'"></A><B>'gcr'</B>* *<A NAME="E545"></A><B>E545</B>* *<A NAME="E546"></A><B>E546</B>* *<A NAME="E548"></A><B>E548</B>* *<A NAME="E549"></A><B>E549</B>*
<A HREF="#'guicursor'">'guicursor'</A> <A HREF="#'gcr'">'gcr'</A> <A HREF="eval.html#string">string</A> (default "n-v-c:block-Cursor/lCursor,
ve:ver35-Cursor,
o:hor50-Cursor,
i-ci:ver25-Cursor/lCursor,
r-cr:hor20-Cursor/lCursor,
sm:block-Cursor
-blinkwait175-blinkoff150-blinkon175",
for <A HREF="os_msdos.html#MS-DOS">MS-DOS</A> and <A HREF="os_win32.html#Win32">Win32</A> console:
"n-v-c:block,o:hor50,i-ci:hor15,
r-cr:hor30,sm:block")
global
{not in Vi}
{only available when compiled with <A HREF="gui.html#GUI">GUI</A> enabled, and
for <A HREF="os_msdos.html#MS-DOS">MS-DOS</A> and <A HREF="os_win32.html#Win32">Win32</A> console}
This option tells Vim what the cursor should look like in different
modes. It fully works in the <A HREF="gui.html#GUI">GUI</A>. In an <A HREF="os_msdos.html#MSDOS">MSDOS</A> or <A HREF="os_win32.html#Win32">Win32</A> console, only
the height of the cursor can be changed. This can be done by
specifying a block cursor, or a percentage for a vertical or
horizontal cursor.
For a console the <A HREF="term.html#'t_SI'">'t_SI'</A>, <A HREF="term.html#'t_SR'">'t_SR'</A>, and <A HREF="term.html#'t_EI'">'t_EI'</A> <A HREF="intro.html#escape">escape</A> sequences are
used.
The option is a comma separated <A HREF="eval.html#list">list</A> of parts. Each part consist of a
mode-list and an <A HREF="editing.html#argument-list">argument-list</A>:
mode-list:argument-list,mode-list:argument-list,..
The mode-list is a dash separated <A HREF="eval.html#list">list</A> of these modes:
<A HREF="pattern.html#n">n</A> <A HREF="intro.html#Normal">Normal</A> mode
<A HREF="visual.html#v">v</A> <A HREF="visual.html#Visual">Visual</A> mode
ve <A HREF="visual.html#Visual">Visual</A> mode with <A HREF="#'selection'">'selection'</A> "<A HREF="motion.html#exclusive">exclusive</A>" (same <A HREF="motion.html#as">as</A> '<A HREF="visual.html#v">v</A>',
if not specified)
<A HREF="insert.html#o">o</A> <A HREF="intro.html#Operator-pending">Operator-pending</A> mode
<A HREF="insert.html#i">i</A> <A HREF="insert.html#Insert">Insert</A> mode
<A HREF="change.html#r">r</A> <A HREF="insert.html#Replace">Replace</A> mode
<A HREF="change.html#c">c</A> <A HREF="cmdline.html#Command-line">Command-line</A> <A HREF="intro.html#Normal">Normal</A> (append) mode
ci <A HREF="cmdline.html#Command-line">Command-line</A> <A HREF="insert.html#Insert">Insert</A> mode
cr <A HREF="cmdline.html#Command-line">Command-line</A> <A HREF="insert.html#Replace">Replace</A> mode
sm showmatch in <A HREF="insert.html#Insert">Insert</A> mode
a all modes
The <A HREF="editing.html#argument-list">argument-list</A> is a dash separated <A HREF="eval.html#list">list</A> of these arguments:
hor{N} horizontal <A HREF="motion.html#bar">bar</A>, {N} percent of the character height
ver{N} vertical <A HREF="motion.html#bar">bar</A>, {N} percent of the character width
block block cursor, fills the whole character
[only one of the above three should be present]
blinkwait{N} *<A NAME="cursor-blinking"></A><B>cursor-blinking</B>*
blinkon{N}
blinkoff{N}
blink times for cursor: blinkwait is the delay before
the cursor starts blinking, blinkon is the time that
the cursor is shown and blinkoff is the time that the
cursor is not shown. The times are in msec. When one
of the numbers is zero, there is no blinking. The
default is: "blinkwait700-blinkon400-blinkoff250".
These numbers are used for a missing entry. This
means that blinking is enabled by default. To switch
blinking off you can use "blinkon0". The cursor only
blinks when Vim is waiting for input, not while
executing a command.
To make the cursor blink in an xterm, see
|<A HREF="syntax.html#xterm-blink">xterm-blink</A>|.
<A HREF="syntax.html#{group-name}">{group-name}</A>
a highlight group name, that sets the color and font
for the cursor
{group-name}/{group-name}
Two highlight group names, the first is used when
no language mappings are used, the other when they
are. |<A HREF="map.html#language-mapping">language-mapping</A>|
Examples of parts:
n-c-v:block-nCursor in <A HREF="intro.html#Normal">Normal</A>, <A HREF="cmdline.html#Command-line">Command-line</A> and <A HREF="visual.html#Visual">Visual</A> mode, use a
block cursor with colors from the "nCursor"
highlight group
i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
In <A HREF="insert.html#Insert">Insert</A> and <A HREF="cmdline.html#Command-line">Command-line</A> <A HREF="insert.html#Insert">Insert</A> mode, use a
30% vertical <A HREF="motion.html#bar">bar</A> cursor with colors from the
"iCursor" highlight group. Blink a bit
faster.
The '<A HREF="insert.html#a">a</A>' mode is different. It will set the given <A HREF="editing.html#argument-list">argument-list</A> for
all modes. It does not reset anything to defaults. This can be used
to <A HREF="diff.html#do">do</A> a common setting for all modes. For example, to switch off
blinking: "a:blinkon0"
Examples of cursor highlighting:
<B> :highlight Cursor gui=reverse guifg=NONE guibg=NONE</B>
<B> :highlight Cursor gui=NONE guifg=bg guibg=fg</B>
*<A NAME="'guifont'"></A><B>'guifont'</B>* *<A NAME="'gfn'"></A><B>'gfn'</B>*
*<A NAME="E235"></A><B>E235</B>* *<A NAME="E596"></A><B>E596</B>*
<A HREF="#'guifont'">'guifont'</A> <A HREF="#'gfn'">'gfn'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not in Vi}
{only available when compiled with <A HREF="gui.html#GUI">GUI</A> enabled}
This is a <A HREF="eval.html#list">list</A> of fonts which will be used for the <A HREF="gui.html#GUI">GUI</A> version of Vim.
In its simplest form the value is just one font name. When
the font cannot be found you will get an error message. To try other
font names a <A HREF="eval.html#list">list</A> can be specified, font names separated with commas.
The first valid font is used.
On systems where <A HREF="#'guifontset'">'guifontset'</A> is supported (X11) and <A HREF="#'guifontset'">'guifontset'</A> is
not empty, then <A HREF="#'guifont'">'guifont'</A> is not used.
Note: As to the <A HREF="gui_x11.html#GTK">GTK</A> GUIs, no error is given against any invalid names,
and the first element of the <A HREF="eval.html#list">list</A> is always picked up and made use of.
This is because, instead of identifying a given name with a font, the
<A HREF="gui_x11.html#GTK">GTK</A> GUIs use <A HREF="motion.html#it">it</A> to construct a <A HREF="pattern.html#pattern">pattern</A> and try to look up a font which
best matches the <A HREF="pattern.html#pattern">pattern</A> among available fonts, and this way, the
matching never fails. An invalid name doesn't matter because a number
of font properties other than name will <A HREF="diff.html#do">do</A> to get the matching done.
Spaces after a comma are ignored. To include a comma in a font name
precede <A HREF="motion.html#it">it</A> with a <A HREF="intro.html#backslash">backslash</A>. Setting an option requires an extra
<A HREF="intro.html#backslash">backslash</A> before a space and a <A HREF="intro.html#backslash">backslash</A>. See also
|<A HREF="#option-backslash">option-backslash</A>|. For example:
<B> :set guifont=Screen15,\ 7x13,font\\,with\\,commas</B>
will make Vim try to use the font "Screen15" first, and if <A HREF="motion.html#it">it</A> fails <A HREF="motion.html#it">it</A>
will try to use "7x13" and then "font,with,commas" instead.
If none of the fonts can be loaded, Vim will keep the current setting.
If an empty font <A HREF="eval.html#list">list</A> is given, Vim will try using other resource
settings (for X, <A HREF="motion.html#it">it</A> will use the Vim.font resource), and finally <A HREF="motion.html#it">it</A>
will try some builtin default which should always be there ("7x13" in
the <A HREF="change.html#case">case</A> of X). The font names given should be "normal" fonts. Vim
will try to find the related <A HREF="syntax.html#bold">bold</A> and <A HREF="syntax.html#italic">italic</A> fonts.
For <A HREF="os_win32.html#Win32">Win32</A>, <A HREF="gui_x11.html#GTK">GTK</A>, <A HREF="gui_x11.html#Motif">Motif</A>, <A HREF="os_mac.html#Mac">Mac</A> OS and Photon:
<B> :set guifont=*</B>
will bring up a font requester, where you can pick the font you want.
The font name depends on the <A HREF="gui.html#GUI">GUI</A> used. See |<A HREF="gui.html#setting-guifont">setting-guifont</A>| for a
way to set <A HREF="#'guifont'">'guifont'</A> for various systems.
For the <A HREF="gui_x11.html#GTK+">GTK+</A> 2 and 3 GUIs, the font name looks like this:
<B> :set guifont=Andale\ Mono\ 11</B>
That's all. XLFDs are not used. For <A HREF="mbyte.html#Chinese">Chinese</A> this is reported to work
well:
<B> if has("gui_gtk2")</B>
<B> set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12</B>
<B> set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12</B>
<B> endif</B>
(Replace gui_gtk2 with gui_gtk3 for the <A HREF="gui_x11.html#GTK+">GTK+</A> 3 <A HREF="gui.html#GUI">GUI</A>)
For <A HREF="os_mac.html#Mac">Mac</A> OSX you can use something like this:
<B> :set guifont=Monaco:h10</B>
Also see <A HREF="#'macatsui'">'macatsui'</A>, <A HREF="motion.html#it">it</A> can help fix display problems.
*<A NAME="E236"></A><B>E236</B>*
Note that the fonts must be mono-spaced (all characters have the same
width). An exception is <A HREF="gui_x11.html#GTK">GTK</A>: all fonts are accepted, but mono-spaced
fonts look best.
To preview a font on <A HREF="#X11">X11</A>, you might be able to use the "xfontsel"
program. The "xlsfonts" program gives a <A HREF="eval.html#list">list</A> of all available fonts.
For the <A HREF="os_win32.html#Win32">Win32</A> <A HREF="gui.html#GUI">GUI</A> *<A NAME="E244"></A><B>E244</B>* *<A NAME="E245"></A><B>E245</B>*
- takes these <A HREF="#options">options</A> in the font name:
hXX - height is XX (points, can be floating-point)
wXX - width is XX (points, can be floating-point)
<A HREF="motion.html#b">b</A> - <A HREF="syntax.html#bold">bold</A>
<A HREF="insert.html#i">i</A> - <A HREF="syntax.html#italic">italic</A>
<A HREF="undo.html#u">u</A> - <A HREF="syntax.html#underline">underline</A>
<A HREF="change.html#s">s</A> - strikeout
cXX - character set XX. Valid charsets are: ANSI, ARABIC,
BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Normally you would use "cDEFAULT".
qXX - quality XX. Valid quality names are: PROOF, DRAFT,
ANTIALIASED, NONANTIALIASED, CLEARTYPE, DEFAULT.
Normally you would use "qDEFAULT".
Some quality values are not supported in legacy OSs.
Use a '<A HREF="cmdline.html#:">:</A>' to separate the <A HREF="#options">options</A>.
- A '<A HREF="motion.html#_">_</A>' can be used in the place of a space, so you don't need to use
backslashes to <A HREF="intro.html#escape">escape</A> the spaces.
- Examples:
<B> :set guifont=courier_new:h12:w5:b:cRUSSIAN</B>
<B> :set guifont=Andale_Mono:h7.5:w4.5</B>
See also |<A HREF="gui_x11.html#font-sizes">font-sizes</A>|.
*<A NAME="'guifontset'"></A><B>'guifontset'</B>* *<A NAME="'gfs'"></A><B>'gfs'</B>*
*<A NAME="E250"></A><B>E250</B>* *<A NAME="E252"></A><B>E252</B>* *<A NAME="E234"></A><B>E234</B>* *<A NAME="E597"></A><B>E597</B>* *<A NAME="E598"></A><B>E598</B>*
<A HREF="#'guifontset'">'guifontset'</A> <A HREF="#'gfs'">'gfs'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not in Vi}
{only available when compiled with <A HREF="gui.html#GUI">GUI</A> enabled and
with the |<A HREF="various.html#+xfontset">+xfontset</A>| feature}
{not available in the <A HREF="gui_x11.html#GTK+">GTK+</A> GUI}
When not empty, specifies two (or more) fonts to be used. The first
one for normal English, the second one for your special language. See
|<A HREF="mbyte.html#xfontset">xfontset</A>|.
Setting this option also means that all font names will be handled <A HREF="motion.html#as">as</A>
a <A HREF="mbyte.html#fontset">fontset</A> name. Also the ones used for the "font" argument of the
|<A HREF="syntax.html#:highlight">:highlight</A>| command.
The fonts must match with the current <A HREF="mbyte.html#locale">locale</A>. If fonts for the
character sets that the current <A HREF="mbyte.html#locale">locale</A> uses are not included, setting
<A HREF="#'guifontset'">'guifontset'</A> will fail.
Note the difference between <A HREF="#'guifont'">'guifont'</A> and <A HREF="#'guifontset'">'guifontset'</A>: In <A HREF="#'guifont'">'guifont'</A>
the comma-separated names are alternative names, one of which will be
used. In <A HREF="#'guifontset'">'guifontset'</A> the whole <A HREF="eval.html#string">string</A> is one <A HREF="mbyte.html#fontset">fontset</A> name,
including the commas. It is not possible to specify alternative
<A HREF="mbyte.html#fontset">fontset</A> names.
This example works on many <A HREF="#X11">X11</A> systems:
<B> :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*</B>
*<A NAME="'guifontwide'"></A><B>'guifontwide'</B>* *<A NAME="'gfw'"></A><B>'gfw'</B>* *<A NAME="E231"></A><B>E231</B>* *<A NAME="E533"></A><B>E533</B>* *<A NAME="E534"></A><B>E534</B>*
<A HREF="#'guifontwide'">'guifontwide'</A> <A HREF="#'gfw'">'gfw'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not in Vi}
{only available when compiled with <A HREF="gui.html#GUI">GUI</A> enabled}
When not empty, specifies a comma-separated <A HREF="eval.html#list">list</A> of fonts to be used
for double-width characters. The first font that can be loaded is
used.
Note: The size of these fonts must be exactly <A HREF="if_cscop.html#twice">twice</A> <A HREF="motion.html#as">as</A> wide <A HREF="motion.html#as">as</A> the one
specified with <A HREF="#'guifont'">'guifont'</A> and the same height.
All <A HREF="gui.html#GUI">GUI</A> versions but <A HREF="gui_x11.html#GTK+">GTK+</A>:
<A HREF="#'guifontwide'">'guifontwide'</A> is only used when <A HREF="#'encoding'">'encoding'</A> is set to "<A HREF="mbyte.html#utf-8">utf-8</A>" and
<A HREF="#'guifontset'">'guifontset'</A> is empty or invalid.
When <A HREF="#'guifont'">'guifont'</A> is set and a valid font is found in <A HREF="motion.html#it">it</A> and
<A HREF="#'guifontwide'">'guifontwide'</A> is empty Vim will attempt to find a matching
double-width font and set <A HREF="#'guifontwide'">'guifontwide'</A> to <A HREF="motion.html#it">it</A>.
<A HREF="gui_x11.html#GTK+">GTK+</A> <A HREF="gui.html#GUI">GUI</A> only: *<A NAME="guifontwide_gtk"></A><B>guifontwide_gtk</B>*
If set and valid, <A HREF="#'guifontwide'">'guifontwide'</A> is always used for double width
characters, even if <A HREF="#'encoding'">'encoding'</A> is not set to "<A HREF="mbyte.html#utf-8">utf-8</A>".
Vim does not attempt to find an appropriate value for <A HREF="#'guifontwide'">'guifontwide'</A>
automatically. If <A HREF="#'guifontwide'">'guifontwide'</A> is empty Pango/Xft will choose the
font for characters not available in <A HREF="#'guifont'">'guifont'</A>. Thus you <A HREF="diff.html#do">do</A> not need
to set <A HREF="#'guifontwide'">'guifontwide'</A> at all unless you want to override the choice
made by Pango/Xft.
Windows +multibyte only: *<A NAME="guifontwide_win_mbyte"></A><B>guifontwide_win_mbyte</B>*
If set and valid, <A HREF="#'guifontwide'">'guifontwide'</A> is used for <A HREF="mbyte.html#IME">IME</A> instead of <A HREF="#'guifont'">'guifont'</A>.
*<A NAME="'guiheadroom'"></A><B>'guiheadroom'</B>* *<A NAME="'ghr'"></A><B>'ghr'</B>*
<A HREF="#'guiheadroom'">'guiheadroom'</A> <A HREF="#'ghr'">'ghr'</A> number (default 50)
global
{not in Vi} {only for <A HREF="gui_x11.html#GTK">GTK</A> and <A HREF="#X11">X11</A> GUI}
The number of pixels subtracted from the screen height when fitting
the <A HREF="gui.html#GUI">GUI</A> <A HREF="windows.html#window">window</A> on the screen. Set this before the <A HREF="gui.html#GUI">GUI</A> is started,
e.g., in your |<A HREF="gui.html#gvimrc">gvimrc</A>| file. When zero, the whole screen height will
be used by the <A HREF="windows.html#window">window</A>. When positive, the specified number of pixel
lines will be left for <A HREF="windows.html#window">window</A> decorations and other items on the
screen. Set <A HREF="motion.html#it">it</A> to a negative value to allow <A HREF="windows.html#windows">windows</A> taller than the
screen.
*<A NAME="'guioptions'"></A><B>'guioptions'</B>* *<A NAME="'go'"></A><B>'go'</B>*
<A HREF="#'guioptions'">'guioptions'</A> <A HREF="#'go'">'go'</A> <A HREF="eval.html#string">string</A> (default "egmrLtT" (MS-Windows, "<A HREF="motion.html#t">t</A>" is
removed in |<A HREF="defaults.html">defaults.vim</A>|),
"aegimrLtT" (GTK, <A HREF="gui_x11.html#Motif">Motif</A> and Athena),
)
global
{not in Vi}
{only available when compiled with <A HREF="gui.html#GUI">GUI</A> enabled}
This option only has an effect in the <A HREF="gui.html#GUI">GUI</A> version of Vim. It is a
sequence of letters which describes what components and <A HREF="#options">options</A> of the
<A HREF="gui.html#GUI">GUI</A> should be used.
To avoid problems with flags that are added in the future, use the
"+=" and "-=" feature of "<A HREF="#:set">:set</A>" |<A HREF="#add-option-flags">add-option-flags</A>|.
Valid letters are <A HREF="motion.html#as">as</A> follows:
*<A NAME="guioptions_a"></A><B>guioptions_a</B>* *<A NAME="'go-a'"></A><B>'go-a'</B>*
'<A HREF="insert.html#a">a</A>' Autoselect: If present, then whenever VISUAL mode is started,
or the <A HREF="visual.html#Visual">Visual</A> area extended, Vim tries to become the owner of
the windowing system's global selection. This means that the
Visually highlighted text is available for pasting into other
applications <A HREF="motion.html#as">as</A> well <A HREF="motion.html#as">as</A> into Vim itself. When the <A HREF="visual.html#Visual">Visual</A> mode
ends, possibly due to an operation on the text, or when an
application wants to paste the selection, the highlighted text
is automatically yanked into the "* selection <A HREF="sponsor.html#register">register</A>.
Thus the selection is still available for pasting into other
applications after the VISUAL mode has ended.
If not present, then Vim won't become the owner of the
windowing system's global selection unless explicitly told to
by a <A HREF="change.html#yank">yank</A> or delete operation for the "* <A HREF="sponsor.html#register">register</A>.
The same applies to the modeless selection.
*<A NAME="'go-P'"></A><B>'go-P'</B>*
'<A HREF="change.html#P">P</A>' Like autoselect but using the "<A HREF="motion.html#+">+</A> <A HREF="sponsor.html#register">register</A> instead of the "*
<A HREF="sponsor.html#register">register</A>.
*<A NAME="'go-A'"></A><B>'go-A'</B>*
'<A HREF="insert.html#A">A</A>' Autoselect for the modeless selection. Like '<A HREF="insert.html#a">a</A>', but only
applies to the modeless selection.
<B><FONT COLOR="PURPLE"> 'guioptions' autoselect Visual autoselect modeless </FONT></B>
"" - -
"<A HREF="insert.html#a">a</A>" yes yes
"<A HREF="insert.html#A">A</A>" - yes
"aA" yes yes
*<A NAME="'go-c'"></A><B>'go-c'</B>*
'<A HREF="change.html#c">c</A>' Use console dialogs instead of popup dialogs for simple
choices.
*<A NAME="'go-e'"></A><B>'go-e'</B>*
'<A HREF="motion.html#e">e</A>' Add <A HREF="intro.html#tab">tab</A> pages when indicated with <A HREF="#'showtabline'">'showtabline'</A>.
<A HREF="#'guitablabel'">'guitablabel'</A> can be used to change the text in the labels.
When '<A HREF="motion.html#e">e</A>' is missing a non-GUI <A HREF="intro.html#tab">tab</A> pages line may be used.
The <A HREF="gui.html#GUI">GUI</A> tabs are only supported on some systems, currently
<A HREF="gui_x11.html#GTK">GTK</A>, <A HREF="gui_x11.html#Motif">Motif</A>, <A HREF="os_mac.html#Mac">Mac</A> OS/X and <A HREF="os_win32.html#MS-Windows">MS-Windows</A>.
*<A NAME="'go-f'"></A><B>'go-f'</B>*
'<A HREF="motion.html#f">f</A>' Foreground: Don't use fork() to detach the <A HREF="gui.html#GUI">GUI</A> from the shell
where <A HREF="motion.html#it">it</A> was started. Use this for programs that wait for the
editor to finish (e.g., an e-mail program). Alternatively you
can use "<A HREF="starting.html#gvim">gvim</A> -f" or "<A HREF="gui_x11.html#:gui">:gui</A> -f" to start the <A HREF="gui.html#GUI">GUI</A> in the
foreground. |<A HREF="gui_x11.html#gui-fork">gui-fork</A>|
Note: Set this option in the <A HREF="starting.html#vimrc">vimrc</A> file. The forking may have
happened already when the |<A HREF="gui.html#gvimrc">gvimrc</A>| file is read.
*<A NAME="'go-i'"></A><B>'go-i'</B>*
'<A HREF="insert.html#i">i</A>' Use a Vim icon. For <A HREF="gui_x11.html#GTK">GTK</A> with <A HREF="gui_x11.html#KDE">KDE</A> <A HREF="motion.html#it">it</A> is used in the left-upper
corner of the <A HREF="windows.html#window">window</A>. It's black&white on non-GTK, because of
limitations of X11. For a color icon, see |<A HREF="gui_x11.html#X11-icon">X11-icon</A>|.
*<A NAME="'go-m'"></A><B>'go-m'</B>*
'<A HREF="motion.html#m">m</A>' Menu <A HREF="motion.html#bar">bar</A> is present.
*<A NAME="'go-M'"></A><B>'go-M'</B>*
'<A HREF="motion.html#M">M</A>' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
that this flag must be added in the <A HREF="starting.html#.vimrc">.vimrc</A> file, before
switching on <A HREF="syntax.html#syntax">syntax</A> or <A HREF="filetype.html#filetype">filetype</A> recognition (when the |<A HREF="gui.html#gvimrc">gvimrc</A>|
file is sourced the system menu has already been loaded; the
`:syntax on` and `:filetype on` commands load the menu too).
*<A NAME="'go-g'"></A><B>'go-g'</B>*
'<A HREF="index.html#g">g</A>' Grey menu items: Make menu items that are not active grey. If
'<A HREF="index.html#g">g</A>' is not included inactive menu items are not shown at all.
Exception: <A HREF="gui_x11.html#Athena">Athena</A> will always use grey menu items.
*<A NAME="'go-t'"></A><B>'go-t'</B>*
'<A HREF="motion.html#t">t</A>' Include tearoff menu items. Currently only works for <A HREF="os_win32.html#Win32">Win32</A>,
<A HREF="gui_x11.html#GTK+">GTK+</A>, and <A HREF="gui_x11.html#Motif">Motif</A> 1.2 <A HREF="gui.html#GUI">GUI</A>.
*<A NAME="'go-T'"></A><B>'go-T'</B>*
'<A HREF="motion.html#T">T</A>' Include Toolbar. Currently only in <A HREF="os_win32.html#Win32">Win32</A>, <A HREF="gui_x11.html#GTK+">GTK+</A>, <A HREF="gui_x11.html#Motif">Motif</A>, Photon
and <A HREF="gui_x11.html#Athena">Athena</A> GUIs.
*<A NAME="'go-r'"></A><B>'go-r'</B>*
'<A HREF="change.html#r">r</A>' Right-hand scrollbar is always present.
*<A NAME="'go-R'"></A><B>'go-R'</B>*
'<A HREF="change.html#R">R</A>' Right-hand scrollbar is present when there is a vertically
split <A HREF="windows.html#window">window</A>.
*<A NAME="'go-l'"></A><B>'go-l'</B>*
'<A HREF="motion.html#l">l</A>' Left-hand scrollbar is always present.
*<A NAME="'go-L'"></A><B>'go-L'</B>*
'<A HREF="motion.html#L">L</A>' Left-hand scrollbar is present when there is a vertically
split <A HREF="windows.html#window">window</A>.
*<A NAME="'go-b'"></A><B>'go-b'</B>*
'<A HREF="motion.html#b">b</A>' Bottom (horizontal) scrollbar is present. Its size depends on
the longest visible line, or on the cursor line if the '<A HREF="motion.html#h">h</A>'
flag is included. |<A HREF="gui.html#gui-horiz-scroll">gui-horiz-scroll</A>|
*<A NAME="'go-h'"></A><B>'go-h'</B>*
'<A HREF="motion.html#h">h</A>' Limit horizontal scrollbar size to the length of the cursor
line. Reduces computations. |<A HREF="gui.html#gui-horiz-scroll">gui-horiz-scroll</A>|
And yes, you may even have scrollbars on the left AND the right if
you really want to :-). See |<A HREF="gui.html#gui-scrollbars">gui-scrollbars</A>| for more information.
*<A NAME="'go-v'"></A><B>'go-v'</B>*
'<A HREF="visual.html#v">v</A>' Use a vertical button layout for dialogs. When not included,
a horizontal layout is preferred, but when <A HREF="motion.html#it">it</A> doesn't fit a
vertical layout is used anyway.
*<A NAME="'go-p'"></A><B>'go-p'</B>*
'<A HREF="change.html#p">p</A>' Use Pointer callbacks for <A HREF="#X11">X11</A> <A HREF="gui.html#GUI">GUI</A>. This is required for some
<A HREF="windows.html#window">window</A> managers. If the cursor is not blinking or hollow at
the right moment, try adding this flag. This must be done
before starting the <A HREF="gui.html#GUI">GUI</A>. Set <A HREF="motion.html#it">it</A> in your |<A HREF="gui.html#gvimrc">gvimrc</A>|. Adding or
removing <A HREF="motion.html#it">it</A> after the <A HREF="gui.html#GUI">GUI</A> has started has no effect.
*<A NAME="'go-F'"></A><B>'go-F'</B>*
'<A HREF="motion.html#F">F</A>' Add a footer. Only for <A HREF="gui_x11.html#Motif">Motif</A>. See |<A HREF="debugger.html#gui-footer">gui-footer</A>|.
*<A NAME="'go-k'"></A><B>'go-k'</B>*
'<A HREF="motion.html#k">k</A>' Keep the <A HREF="gui.html#GUI">GUI</A> <A HREF="windows.html#window">window</A> size when adding/removing a scrollbar, or
toolbar, tabline, etc. Instead, the behavior is similar to
when the <A HREF="windows.html#window">window</A> is maximized and will adjust <A HREF="#'lines'">'lines'</A> and
<A HREF="#'columns'">'columns'</A> to fit to the <A HREF="windows.html#window">window</A>. Without the '<A HREF="motion.html#k">k</A>' flag Vim will
try to keep <A HREF="#'lines'">'lines'</A> and <A HREF="#'columns'">'columns'</A> the same when adding and
removing <A HREF="gui.html#GUI">GUI</A> components.
*<A NAME="'guipty'"></A><B>'guipty'</B>* *<A NAME="'noguipty'"></A><B>'noguipty'</B>*
<A HREF="#'guipty'">'guipty'</A> <A HREF="#boolean">boolean</A> (default on)
global
{not in Vi}
{only available when compiled with <A HREF="gui.html#GUI">GUI</A> enabled}
Only in the <A HREF="gui.html#GUI">GUI</A>: If on, an attempt is made to open a pseudo-tty for
I/O to/from shell commands. See |<A HREF="gui_x11.html#gui-pty">gui-pty</A>|.
*<A NAME="'guitablabel'"></A><B>'guitablabel'</B>* *<A NAME="'gtl'"></A><B>'gtl'</B>*
<A HREF="#'guitablabel'">'guitablabel'</A> <A HREF="#'gtl'">'gtl'</A> <A HREF="eval.html#string">string</A> (default empty)
global
{not in Vi}
{only available when compiled with <A HREF="gui.html#GUI">GUI</A> enabled and
with the |<A HREF="various.html#+windows">+windows</A>| feature}
When nonempty describes the text to use in a label of the <A HREF="gui.html#GUI">GUI</A> <A HREF="intro.html#tab">tab</A>
pages line. When empty and when the result is empty Vim will use a
default label. See |<A HREF="tabpage.html#setting-guitablabel">setting-guitablabel</A>| for more info.
The format of this option is like that of <A HREF="#'statusline'">'statusline'</A>.
<A HREF="#'guitabtooltip'">'guitabtooltip'</A> is used for the tooltip, see below.
The <A HREF="eval.html#expression">expression</A> will be evaluated in the |<A HREF="eval.html#sandbox">sandbox</A>| when set from a
<A HREF="#modeline">modeline</A>, see |<A HREF="eval.html#sandbox-option">sandbox-option</A>|.
Only used when the <A HREF="gui.html#GUI">GUI</A> <A HREF="intro.html#tab">tab</A> pages line is displayed. '<A HREF="motion.html#e">e</A>' must be
present in <A HREF="#'guioptions'">'guioptions'</A>. For the non-GUI <A HREF="intro.html#tab">tab</A> pages line <A HREF="#'tabline'">'tabline'</A> is
used.
*<A NAME="'guitabtooltip'"></A><B>'guitabtooltip'</B>* *<A NAME="'gtt'"></A><B>'gtt'</B>*
<A HREF="#'guitabtooltip'">'guitabtooltip'</A> <A HREF="#'gtt'">'gtt'</A> <A HREF="eval.html#string">string</A> (default empty)
global
{not in Vi}
{only available when compiled with <A HREF="gui.html#GUI">GUI</A> enabled and
with the |<A HREF="various.html#+windows">+windows</A>| feature}
When nonempty describes the text to use in a tooltip for the <A HREF="gui.html#GUI">GUI</A> <A HREF="intro.html#tab">tab</A>
pages line. When empty Vim will use a default tooltip.
This option is otherwise just like <A HREF="#'guitablabel'">'guitablabel'</A> above.
You can include a line break. Simplest method is to use YXXY:let|:
<B> :let &guitabtooltip = "line one\nline two"</B>
*<A NAME="'helpfile'"></A><B>'helpfile'</B>* *<A NAME="'hf'"></A><B>'hf'</B>*
<A HREF="#'helpfile'">'helpfile'</A> <A HREF="#'hf'">'hf'</A> <A HREF="eval.html#string">string</A> (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
(others) "$VIMRUNTIME/doc/help.txt")
global
{not in Vi}
Name of the main help file. All distributed help files should be
placed together in one directory. Additionally, all "doc" directories
in <A HREF="#'runtimepath'">'runtimepath'</A> will be used.
Environment <A HREF="eval.html#variables">variables</A> are expanded |<A HREF="#:set_env">:set_env</A>|. For example:
"$VIMRUNTIME/doc/help.txt". If <A HREF="starting.html#$VIMRUNTIME">$VIMRUNTIME</A> is not set, <A HREF="starting.html#$VIM">$VIM</A> is also
tried. Also see |<A HREF="starting.html#$VIMRUNTIME">$VIMRUNTIME</A>| and |<A HREF="#option-backslash">option-backslash</A>| about including
spaces and backslashes.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'helpheight'"></A><B>'helpheight'</B>* *<A NAME="'hh'"></A><B>'hh'</B>*
<A HREF="#'helpheight'">'helpheight'</A> <A HREF="#'hh'">'hh'</A> number (default 20)
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+windows">+windows</A>|
feature}
Minimal initial height of the help <A HREF="windows.html#window">window</A> when <A HREF="motion.html#it">it</A> is opened with the
"<A HREF="helphelp.html#:help">:help</A>" command. The initial height of the help <A HREF="windows.html#window">window</A> is half of the
current <A HREF="windows.html#window">window</A>, or (when the <A HREF="#'ea'">'ea'</A> option is on) the same <A HREF="motion.html#as">as</A> other
<A HREF="windows.html#windows">windows</A>. When the height is <A HREF="various.html#less">less</A> than <A HREF="#'helpheight'">'helpheight'</A>, the height is
set to <A HREF="#'helpheight'">'helpheight'</A>. Set to zero to disable.
*<A NAME="'helplang'"></A><B>'helplang'</B>* *<A NAME="'hlg'"></A><B>'hlg'</B>*
<A HREF="#'helplang'">'helplang'</A> <A HREF="#'hlg'">'hlg'</A> <A HREF="eval.html#string">string</A> (default: <A HREF="message.html#messages">messages</A> language or empty)
global
{only available when compiled with the |<A HREF="various.html#+multi_lang">+multi_lang</A>|
feature}
{not in Vi}
Comma separated <A HREF="eval.html#list">list</A> of languages. Vim will use the first language
for which the desired help can be found. The English help will always
be used <A HREF="motion.html#as">as</A> a last resort. You can add "en" to prefer English over
another language, but that will only find <A HREF="tagsrch.html#tags">tags</A> that exist in that
language and not in the English help.
Example:
<B> :set helplang=de,it</B>
This will first search German, then Italian and finally English help
files.
When using |<A HREF="tagsrch.html#CTRL-]">CTRL-]</A>| and ":help!" in a non-English help file Vim will
try to find the <A HREF="tagsrch.html#tag">tag</A> in the current language before using this option.
See |<A HREF="helphelp.html#help-translated">help-translated</A>|.
*<A NAME="'hidden'"></A><B>'hidden'</B>* *<A NAME="'hid'"></A><B>'hid'</B>* *<A NAME="'nohidden'"></A><B>'nohidden'</B>* *<A NAME="'nohid'"></A><B>'nohid'</B>*
<A HREF="#'hidden'">'hidden'</A> <A HREF="#'hid'">'hid'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
When off a buffer is unloaded when <A HREF="motion.html#it">it</A> is |abandon|ed. When on a
buffer becomes hidden when <A HREF="motion.html#it">it</A> is |abandon|ed. If the buffer is still
displayed in another <A HREF="windows.html#window">window</A>, <A HREF="motion.html#it">it</A> does not become hidden, of course.
The commands that move through the buffer <A HREF="eval.html#list">list</A> sometimes make a buffer
hidden although the <A HREF="#'hidden'">'hidden'</A> option is off: When the buffer is
modified, <A HREF="#'autowrite'">'autowrite'</A> is off or <A HREF="editing.html#writing">writing</A> is not possible, and the '<A HREF="change.html#!">!</A>'
flag was used. See also |<A HREF="windows.html">windows.txt</A>|.
To only make one buffer hidden use the <A HREF="#'bufhidden'">'bufhidden'</A> option.
This option is set for one command with ":hide {command}" |<A HREF="windows.html#:hide">:hide</A>|.
WARNING: It's <A HREF="starting.html#easy">easy</A> to forget that you have changes in hidden <A HREF="windows.html#buffers">buffers</A>.
Think <A HREF="if_cscop.html#twice">twice</A> when using ":q!" or ":qa!".
*<A NAME="'highlight'"></A><B>'highlight'</B>* *<A NAME="'hl'"></A><B>'hl'</B>*
<A HREF="#'highlight'">'highlight'</A> <A HREF="#'hl'">'hl'</A> <A HREF="eval.html#string">string</A> (default (as a single string):
"8:SpecialKey,~:EndOfBuffer,@:NonText,
d:Directory,e:ErrorMsg,i:IncSearch,
l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
N:CursorLineNr,r:Question,s:StatusLine,
S:StatusLineNC,c:VertSplit,t:Title,
v:Visual,w:WarningMsg,W:WildMenu,f:Folded,
F:FoldColumn,A:DiffAdd,C:DiffChange,
D:DiffDelete,T:DiffText,>:SignColumn,
B:SpellBad,P:SpellCap,R:SpellRare,
L:SpellLocal,-:Conceal,+:Pmenu,=:PmenuSel,
x:PmenuSbar,X:PmenuThumb,*:TabLine,
#:TabLineSel,_:TabLineFill,!:CursorColumn,
.:CursorLine,o:ColorColumn,q:QuickFixLine,
z:StatusLineTerm,Z:StatusLineTermNC")
global
{not in Vi}
This option can be used to set highlighting mode for various
occasions. It is a comma separated <A HREF="eval.html#list">list</A> of character pairs. The
first character in a pair gives the occasion, the second the mode to
use for that occasion. The occasions are:
|<A HREF="syntax.html#hl-SpecialKey">hl-SpecialKey</A>| 8 Meta and special keys listed with "<A HREF="map.html#:map">:map</A>"
|<A HREF="syntax.html#hl-EndOfBuffer">hl-EndOfBuffer</A>| ~ lines after the last line in the buffer
|<A HREF="syntax.html#hl-NonText">hl-NonText</A>| @ '<A HREF="repeat.html#@">@</A>' at the end of the <A HREF="windows.html#window">window</A> and
characters from <A HREF="#'showbreak'">'showbreak'</A>
|<A HREF="syntax.html#hl-Directory">hl-Directory</A>| <A HREF="change.html#d">d</A> directories in <A HREF="scroll.html#CTRL-D">CTRL-D</A> listing and other special
things in listings
|<A HREF="syntax.html#hl-ErrorMsg">hl-ErrorMsg</A>| <A HREF="motion.html#e">e</A> error <A HREF="message.html#messages">messages</A>
<A HREF="motion.html#h">h</A> (obsolete, ignored)
|<A HREF="syntax.html#hl-IncSearch">hl-IncSearch</A>| <A HREF="insert.html#i">i</A> <A HREF="#'incsearch'">'incsearch'</A> highlighting
|<A HREF="syntax.html#hl-Search">hl-Search</A>| l last search <A HREF="pattern.html#pattern">pattern</A> highlighting (see <A HREF="#'hlsearch'">'hlsearch'</A>)
|<A HREF="syntax.html#hl-MoreMsg">hl-MoreMsg</A>| m |<A HREF="message.html#more-prompt">more-prompt</A>|
|<A HREF="syntax.html#hl-ModeMsg">hl-ModeMsg</A>| M Mode (e.g., "<A HREF="starting.html#--">--</A> INSERT --")
|<A HREF="syntax.html#hl-LineNr">hl-LineNr</A>| n line number for "<A HREF="various.html#:number">:number</A>" and "<A HREF="various.html#:#">:#</A>" commands, and
when <A HREF="#'number'">'number'</A> or <A HREF="#'relativenumber'">'relativenumber'</A> option is set.
|<A HREF="syntax.html#hl-CursorLineNr">hl-CursorLineNr</A>| N like n for when <A HREF="#'cursorline'">'cursorline'</A> or <A HREF="#'relativenumber'">'relativenumber'</A> is
set.
|<A HREF="syntax.html#hl-Question">hl-Question</A>| r |<A HREF="message.html#hit-enter">hit-enter</A>| prompt and yes/no questions
|<A HREF="syntax.html#hl-StatusLine">hl-StatusLine</A>| s status line of current <A HREF="windows.html#window">window</A> |<A HREF="windows.html#status-line">status-line</A>|
|<A HREF="syntax.html#hl-StatusLineNC">hl-StatusLineNC</A>| S status lines of not-current <A HREF="windows.html#windows">windows</A>
|<A HREF="syntax.html#hl-Title">hl-Title</A>| t Titles for output from "<A HREF="#:set">:set</A> all", "<A HREF="autocmd.html#:autocmd">:autocmd</A>" etc.
|<A HREF="syntax.html#hl-VertSplit">hl-VertSplit</A>| <A HREF="change.html#c">c</A> column used to separate vertically split <A HREF="windows.html#windows">windows</A>
|<A HREF="syntax.html#hl-Visual">hl-Visual</A>| <A HREF="visual.html#v">v</A> Visual mode
|<A HREF="syntax.html#hl-VisualNOS">hl-VisualNOS</A>| V Visual mode when Vim does is "Not Owning the
Selection" Only <A HREF="#X11">X11</A> Gui's |<A HREF="gui_x11.html#gui-x11">gui-x11</A>| and
|<A HREF="term.html#xterm-clipboard">xterm-clipboard</A>|.
|<A HREF="syntax.html#hl-WarningMsg">hl-WarningMsg</A>| <A HREF="motion.html#w">w</A> warning <A HREF="message.html#messages">messages</A>
|<A HREF="syntax.html#hl-WildMenu">hl-WildMenu</A>| W <A HREF="editing.html#wildcard">wildcard</A> matches displayed for <A HREF="#'wildmenu'">'wildmenu'</A>
|<A HREF="syntax.html#hl-Folded">hl-Folded</A>| <A HREF="motion.html#f">f</A> line used for closed <A HREF="fold.html#folds">folds</A>
|<A HREF="syntax.html#hl-FoldColumn">hl-FoldColumn</A>| F <A HREF="#'foldcolumn'">'foldcolumn'</A>
|<A HREF="syntax.html#hl-DiffAdd">hl-DiffAdd</A>| A added line in <A HREF="diff.html#diff">diff</A> mode
|<A HREF="syntax.html#hl-DiffChange">hl-DiffChange</A>| C changed line in <A HREF="diff.html#diff">diff</A> mode
|<A HREF="syntax.html#hl-DiffDelete">hl-DiffDelete</A>| D deleted line in <A HREF="diff.html#diff">diff</A> mode
|<A HREF="syntax.html#hl-DiffText">hl-DiffText</A>| T inserted text in <A HREF="diff.html#diff">diff</A> mode
|<A HREF="syntax.html#hl-SignColumn">hl-SignColumn</A>| <A HREF="change.html#>">></A> column used for |<A HREF="sign.html#signs">signs</A>|
|<A HREF="syntax.html#hl-SpellBad">hl-SpellBad</A>| B misspelled <A HREF="motion.html#word">word</A> |<A HREF="spell.html#spell">spell</A>|
|<A HREF="syntax.html#hl-SpellCap">hl-SpellCap</A>| <A HREF="change.html#P">P</A> <A HREF="motion.html#word">word</A> that should start with capital |<A HREF="spell.html#spell">spell</A>|
|<A HREF="syntax.html#hl-SpellRare">hl-SpellRare</A>| R rare <A HREF="motion.html#word">word</A> |<A HREF="spell.html#spell">spell</A>|
|<A HREF="syntax.html#hl-SpellLocal">hl-SpellLocal</A>| L <A HREF="motion.html#word">word</A> from other region |<A HREF="spell.html#spell">spell</A>|
|<A HREF="syntax.html#hl-Conceal">hl-Conceal</A>| - the placeholders used for concealed characters
(see <A HREF="#'conceallevel'">'conceallevel'</A>)
|<A HREF="syntax.html#hl-Pmenu">hl-Pmenu</A>| + popup menu normal line
|<A HREF="syntax.html#hl-PmenuSel">hl-PmenuSel</A>| = popup menu normal line
|<A HREF="syntax.html#hl-PmenuSbar">hl-PmenuSbar</A>| <A HREF="change.html#x">x</A> popup menu scrollbar
|<A HREF="syntax.html#hl-PmenuThumb">hl-PmenuThumb</A>| X popup menu scrollbar thumb
The display modes are:
<A HREF="change.html#r">r</A> reverse (termcap entry "mr" and "me")
<A HREF="insert.html#i">i</A> <A HREF="syntax.html#italic">italic</A> (termcap entry "ZH" and "ZR")
<A HREF="motion.html#b">b</A> <A HREF="syntax.html#bold">bold</A> (termcap entry "md" and "me")
<A HREF="change.html#s">s</A> <A HREF="syntax.html#standout">standout</A> (termcap entry "so" and "se")
<A HREF="undo.html#u">u</A> <A HREF="syntax.html#underline">underline</A> (termcap entry "us" and "ue")
<A HREF="change.html#c">c</A> <A HREF="syntax.html#undercurl">undercurl</A> (termcap entry "Cs" and "Ce")
t <A HREF="syntax.html#strikethrough">strikethrough</A> (termcap entry "Ts" and "Te")
<A HREF="pattern.html#n">n</A> no highlighting
- no highlighting
: use a highlight group
The default is used for occasions that are not included.
If you want to change what the display modes do, see |<A HREF="os_dos.html#dos-colors">dos-colors</A>|
for an example.
When using the '<A HREF="cmdline.html#:">:</A>' display mode, this must be followed by the name of
a highlight group. A highlight group can be used to define any type
of highlighting, including using color. See |<A HREF="syntax.html#:highlight">:highlight</A>| on how to
define one. The default uses a different group for each occasion.
See |<A HREF="syntax.html#highlight-default">highlight-default</A>| for the default highlight groups.
*<A NAME="'history'"></A><B>'history'</B>* *<A NAME="'hi'"></A><B>'hi'</B>*
<A HREF="#'history'">'history'</A> <A HREF="#'hi'">'hi'</A> number (Vim default: 50, <A HREF="intro.html#Vi">Vi</A> default: 0,
set to 200 in |<A HREF="defaults.html">defaults.vim</A>|)
global
{not in Vi}
A <A HREF="cmdline.html#history">history</A> of "<A HREF="cmdline.html#:">:</A>" commands, and a <A HREF="cmdline.html#history">history</A> of previous search patterns
is remembered. This option decides how many entries may be stored in
each of these histories (see |<A HREF="cmdline.html#cmdline-editing">cmdline-editing</A>|).
The maximum value is 10000.
NOTE: This option is set to the <A HREF="intro.html#Vi">Vi</A> default value when <A HREF="#'compatible'">'compatible'</A> is
set and to the Vim default value when <A HREF="#'compatible'">'compatible'</A> is reset.
*<A NAME="'hkmap'"></A><B>'hkmap'</B>* *<A NAME="'hk'"></A><B>'hk'</B>* *<A NAME="'nohkmap'"></A><B>'nohkmap'</B>* *<A NAME="'nohk'"></A><B>'nohk'</B>*
<A HREF="#'hkmap'">'hkmap'</A> <A HREF="#'hk'">'hk'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+rightleft">+rightleft</A>|
feature}
When on, the keyboard is mapped for the Hebrew character set.
Normally you would set <A HREF="#'allowrevins'">'allowrevins'</A> and use CTRL-_ in insert mode to
toggle this option. See |<A HREF="rileft.html">rileft.txt</A>|.
NOTE: This option is reset when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'hkmapp'"></A><B>'hkmapp'</B>* *<A NAME="'hkp'"></A><B>'hkp'</B>* *<A NAME="'nohkmapp'"></A><B>'nohkmapp'</B>* *<A NAME="'nohkp'"></A><B>'nohkp'</B>*
<A HREF="#'hkmapp'">'hkmapp'</A> <A HREF="#'hkp'">'hkp'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+rightleft">+rightleft</A>|
feature}
When on, phonetic keyboard <A HREF="map.html#mapping">mapping</A> is used. <A HREF="#'hkmap'">'hkmap'</A> must also be on.
This is useful if you have a non-Hebrew keyboard.
See |<A HREF="rileft.html">rileft.txt</A>|.
NOTE: This option is reset when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'hlsearch'"></A><B>'hlsearch'</B>* *<A NAME="'hls'"></A><B>'hls'</B>* *<A NAME="'nohlsearch'"></A><B>'nohlsearch'</B>* *<A NAME="'nohls'"></A><B>'nohls'</B>*
<A HREF="#'hlsearch'">'hlsearch'</A> <A HREF="#'hls'">'hls'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
{not available when compiled without the
|<A HREF="various.html#+extra_search">+extra_search</A>| feature}
When there is a previous search <A HREF="pattern.html#pattern">pattern</A>, highlight all its matches.
The type of highlighting used can be set with the '<A HREF="motion.html#l">l</A>' occasion in the
<A HREF="#'highlight'">'highlight'</A> option. This uses the "Search" highlight group by
default. Note that only the matching text is highlighted, any offsets
are not applied.
See also: <A HREF="#'incsearch'">'incsearch'</A> and |<A HREF="pattern.html#:match">:match</A>|.
When you get bored looking at the highlighted matches, you can turn <A HREF="motion.html#it">it</A>
off with |<A HREF="pattern.html#:nohlsearch">:nohlsearch</A>|. This does not change the option value, <A HREF="motion.html#as">as</A>
soon <A HREF="motion.html#as">as</A> you use a search command, the highlighting comes back.
<A HREF="#'redrawtime'">'redrawtime'</A> specifies the maximum time spent on finding matches.
When the search <A HREF="pattern.html#pattern">pattern</A> can match an end-of-line, Vim will try to
highlight all of the matched text. However, this depends on where the
search starts. This will be the first line in the <A HREF="windows.html#window">window</A> or the first
line below a closed fold. A match in a previous line which is not
drawn may not continue in a newly drawn line.
You can specify whether the highlight status is restored on <A HREF="starting.html#startup">startup</A>
with the 'h' flag in <A HREF="#'viminfo'">'viminfo'</A> |<A HREF="#viminfo-h">viminfo-h</A>|.
NOTE: This option is reset when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'icon'"></A><B>'icon'</B>* *<A NAME="'noicon'"></A><B>'noicon'</B>*
<A HREF="#'icon'">'icon'</A> <A HREF="#boolean">boolean</A> (default off, on when title can be restored)
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+title">+title</A>|
feature}
When on, the icon text of the <A HREF="windows.html#window">window</A> will be set to the value of
<A HREF="#'iconstring'">'iconstring'</A> (if <A HREF="motion.html#it">it</A> is not empty), or to the name of the file
currently being edited. Only the last part of the name is used.
Overridden by the <A HREF="#'iconstring'">'iconstring'</A> option.
Only works if the <A HREF="terminal.html#terminal">terminal</A> supports setting <A HREF="windows.html#window">window</A> icons (currently
only <A HREF="#X11">X11</A> <A HREF="gui.html#GUI">GUI</A> and terminals with a non-empty <A HREF="term.html#'t_IS'">'t_IS'</A> option - these are
<A HREF="os_unix.html#Unix">Unix</A> xterm and iris-ansi by default, where <A HREF="term.html#'t_IS'">'t_IS'</A> is taken from the
builtin <A HREF="term.html#termcap">termcap</A>).
When Vim was compiled with HAVE_X11 defined, the original icon will be
restored if possible |<A HREF="#X11">X11</A>|. See |<A HREF="gui_x11.html#X11-icon">X11-icon</A>| for <A HREF="change.html#changing">changing</A> the icon on
<A HREF="#X11">X11</A>.
For <A HREF="os_win32.html#MS-Windows">MS-Windows</A> the icon can be changed, see |<A HREF="os_win32.html#windows-icon">windows-icon</A>|.
*<A NAME="'iconstring'"></A><B>'iconstring'</B>*
<A HREF="#'iconstring'">'iconstring'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+title">+title</A>|
feature}
When this option is not empty, <A HREF="motion.html#it">it</A> will be used for the icon text of
the <A HREF="windows.html#window">window</A>. This happens only when the <A HREF="#'icon'">'icon'</A> option is on.
Only works if the <A HREF="terminal.html#terminal">terminal</A> supports setting <A HREF="windows.html#window">window</A> icon text
(currently only <A HREF="#X11">X11</A> <A HREF="gui.html#GUI">GUI</A> and terminals with a non-empty <A HREF="term.html#'t_IS'">'t_IS'</A> option).
Does not work for MS Windows.
When Vim was compiled with HAVE_X11 defined, the original icon will be
restored if possible |<A HREF="#X11">X11</A>|.
When this option contains printf-style '<A HREF="motion.html#%">%</A>' items, they will be
expanded according to the rules used for <A HREF="#'statusline'">'statusline'</A>. See
<A HREF="#'titlestring'">'titlestring'</A> for example settings.
{not available when compiled without the |<A HREF="various.html#+statusline">+statusline</A>| feature}
*<A NAME="'ignorecase'"></A><B>'ignorecase'</B>* *<A NAME="'ic'"></A><B>'ic'</B>* *<A NAME="'noignorecase'"></A><B>'noignorecase'</B>* *<A NAME="'noic'"></A><B>'noic'</B>*
<A HREF="#'ignorecase'">'ignorecase'</A> <A HREF="#'ic'">'ic'</A> <A HREF="#boolean">boolean</A> (default off)
global
Ignore <A HREF="change.html#case">case</A> in search patterns. Also used when searching in the <A HREF="tagsrch.html#tags">tags</A>
file.
Also see <A HREF="#'smartcase'">'smartcase'</A> and <A HREF="#'tagcase'">'tagcase'</A>.
Can be overruled by using "\c" or "\C" in the <A HREF="pattern.html#pattern">pattern</A>, see
|<A HREF="pattern.html#/ignorecase">/ignorecase</A>|.
*<A NAME="'imactivatefunc'"></A><B>'imactivatefunc'</B>* *<A NAME="'imaf'"></A><B>'imaf'</B>*
<A HREF="#'imactivatefunc'">'imactivatefunc'</A> <A HREF="#'imaf'">'imaf'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not in Vi}
{only available when compiled with YXXY+mbyte|}
This option specifies a function that will be called to
activate or deactivate the Input Method.
It is not used in the <A HREF="gui.html#GUI">GUI</A>.
Example:
<B> function ImActivateFunc(active)</B>
<B> if a:active</B>
<B> ... do something</B>
<B> else</B>
<B> ... do something</B>
<B> endif</B>
<B> " return value is not used</B>
<B> endfunction</B>
<B> set imactivatefunc=ImActivateFunc</B>
*<A NAME="'imactivatekey'"></A><B>'imactivatekey'</B>* *<A NAME="'imak'"></A><B>'imak'</B>*
<A HREF="#'imactivatekey'">'imactivatekey'</A> <A HREF="#'imak'">'imak'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not in Vi}
{only available when compiled with |<A HREF="various.html#+xim">+xim</A>| and
YXXY+GUI_GTK|} *<A NAME="E599"></A><B>E599</B>*
Specifies the key that your Input Method in X-Windows uses for
activation. When this is specified correctly, vim can fully <A HREF="intro.html#control">control</A>
IM with <A HREF="#'imcmdline'">'imcmdline'</A>, <A HREF="#'iminsert'">'iminsert'</A> and <A HREF="#'imsearch'">'imsearch'</A>.
You can't use this option to change the activation key, the option
tells Vim what the key is.
Format:
[MODIFIER_FLAG-]KEY_STRING
These characters can be used for MODIFIER_FLAG (case is ignored):
<A HREF="change.html#S">S</A> Shift key
<A HREF="motion.html#L">L</A> Lock key
C Control key
1 Mod1 key
2 Mod2 key
3 Mod3 key
4 Mod4 key
5 Mod5 key
Combinations are allowed, for example "S-C-space" or "SC-space" are
both shift+ctrl+space.
See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
Example:
<B> :set imactivatekey=S-space</B>
"S-space" means shift+space. This is the activation key for kinput2 +
canna (Japanese), and ami (Korean).
*<A NAME="'imcmdline'"></A><B>'imcmdline'</B>* *<A NAME="'imc'"></A><B>'imc'</B>* *<A NAME="'noimcmdline'"></A><B>'noimcmdline'</B>* *<A NAME="'noimc'"></A><B>'noimc'</B>*
<A HREF="#'imcmdline'">'imcmdline'</A> <A HREF="#'imc'">'imc'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
{only available when compiled with YXXY+mbyte|}
When set the Input Method is always on when starting to edit a command
line, unless entering a search <A HREF="pattern.html#pattern">pattern</A> (see <A HREF="#'imsearch'">'imsearch'</A> for that).
Setting this option is useful when your input method allows entering
English characters directly, e.g., when it's used to type accented
characters with dead keys.
*<A NAME="'imdisable'"></A><B>'imdisable'</B>* *<A NAME="'imd'"></A><B>'imd'</B>* *<A NAME="'noimdisable'"></A><B>'noimdisable'</B>* *<A NAME="'noimd'"></A><B>'noimd'</B>*
<A HREF="#'imdisable'">'imdisable'</A> <A HREF="#'imd'">'imd'</A> <A HREF="#boolean">boolean</A> (default off, on for some systems (SGI))
global
{not in Vi}
{only available when compiled with YXXY+mbyte|}
When set the Input Method is never used. This is useful to disable
the IM when <A HREF="motion.html#it">it</A> doesn't work properly.
Currently this option is on by default for SGI/IRIX machines. This
may change in later releases.
*<A NAME="'iminsert'"></A><B>'iminsert'</B>* *<A NAME="'imi'"></A><B>'imi'</B>*
<A HREF="#'iminsert'">'iminsert'</A> <A HREF="#'imi'">'imi'</A> number (default 0)
local to buffer
{not in Vi}
Specifies whether <A HREF="map.html#:lmap">:lmap</A> or an Input Method (IM) is to be used in
<A HREF="insert.html#Insert">Insert</A> mode. Valid values:
0 <A HREF="map.html#:lmap">:lmap</A> is off and IM is off
1 <A HREF="map.html#:lmap">:lmap</A> is ON and IM is off
2 <A HREF="map.html#:lmap">:lmap</A> is off and IM is ON
To always reset the option to zero when leaving <A HREF="insert.html#Insert">Insert</A> mode with <A HREF="intro.html#<Esc>"><Esc></A>
this can be used:
<B> :inoremap <ESC> <ESC>:set iminsert=0<CR></B>
This makes <A HREF="map.html#:lmap">:lmap</A> and IM turn off automatically when leaving <A HREF="insert.html#Insert">Insert</A>
mode.
Note that this option changes when using <A HREF="editing.html#CTRL-^">CTRL-^</A> in <A HREF="insert.html#Insert">Insert</A> mode
|<A HREF="insert.html#i_CTRL-^">i_CTRL-^</A>|.
The value is set to 1 when setting <A HREF="#'keymap'">'keymap'</A> to a valid keymap name.
It is also used for the argument of commands like "<A HREF="change.html#r">r</A>" and "<A HREF="motion.html#f">f</A>".
The value 0 may not work correctly with <A HREF="gui_x11.html#Athena">Athena</A> and <A HREF="gui_x11.html#Motif">Motif</A> with some <A HREF="mbyte.html#XIM">XIM</A>
methods. Use <A HREF="#'imdisable'">'imdisable'</A> to disable <A HREF="mbyte.html#XIM">XIM</A> then.
You can set <A HREF="#'imactivatefunc'">'imactivatefunc'</A> and <A HREF="#'imstatusfunc'">'imstatusfunc'</A> to handle IME/XIM
via external command if vim is not compiled with the |<A HREF="various.html#+xim">+xim</A>|,
|<A HREF="various.html#+multi_byte_ime">+multi_byte_ime</A>| or |<A HREF="mbyte.html#global-ime">global-ime</A>|.
*<A NAME="'imsearch'"></A><B>'imsearch'</B>* *<A NAME="'ims'"></A><B>'ims'</B>*
<A HREF="#'imsearch'">'imsearch'</A> <A HREF="#'ims'">'ims'</A> number (default -1)
local to buffer
{not in Vi}
Specifies whether <A HREF="map.html#:lmap">:lmap</A> or an Input Method (IM) is to be used when
entering a search <A HREF="pattern.html#pattern">pattern</A>. Valid values:
-1 the value of <A HREF="#'iminsert'">'iminsert'</A> is used, makes <A HREF="motion.html#it">it</A> look like
<A HREF="#'iminsert'">'iminsert'</A> is also used when typing a search <A HREF="pattern.html#pattern">pattern</A>
0 <A HREF="map.html#:lmap">:lmap</A> is off and IM is off
1 <A HREF="map.html#:lmap">:lmap</A> is ON and IM is off
2 <A HREF="map.html#:lmap">:lmap</A> is off and IM is ON
Note that this option changes when using <A HREF="editing.html#CTRL-^">CTRL-^</A> in <A HREF="cmdline.html#Command-line">Command-line</A> mode
|<A HREF="cmdline.html#c_CTRL-^">c_CTRL-^</A>|.
The value is set to 1 when <A HREF="motion.html#it">it</A> is not -1 and setting the <A HREF="#'keymap'">'keymap'</A>
option to a valid keymap name.
The value 0 may not work correctly with <A HREF="gui_x11.html#Athena">Athena</A> and <A HREF="gui_x11.html#Motif">Motif</A> with some <A HREF="mbyte.html#XIM">XIM</A>
methods. Use <A HREF="#'imdisable'">'imdisable'</A> to disable <A HREF="mbyte.html#XIM">XIM</A> then.
*<A NAME="'imstatusfunc'"></A><B>'imstatusfunc'</B>* *<A NAME="'imsf'"></A><B>'imsf'</B>*
<A HREF="#'imstatusfunc'">'imstatusfunc'</A> <A HREF="#'imsf'">'imsf'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not in Vi}
{only available when compiled with YXXY+mbyte|}
This option specifies a function that is called to obtain the status
of Input Method. It must return a positive number when <A HREF="mbyte.html#IME">IME</A> is active.
It is not used in the <A HREF="gui.html#GUI">GUI</A>.
Example:
<B> function ImStatusFunc()</B>
<B> let is_active = ...do something</B>
<B> return is_active ? 1 : 0</B>
<B> endfunction</B>
<B> set imstatusfunc=ImStatusFunc</B>
NOTE: This function is invoked very often. Keep <A HREF="motion.html#it">it</A> fast.
*<A NAME="'imstyle'"></A><B>'imstyle'</B>* *<A NAME="'imst'"></A><B>'imst'</B>*
<A HREF="#'imstyle'">'imstyle'</A> <A HREF="#'imst'">'imst'</A> number (default 1)
global
{not in Vi}
{only available when compiled with |<A HREF="various.html#+xim">+xim</A>| and
YXXY+GUI_GTK|}
This option specifies the input style of Input Method:
0 use on-the-spot style
1 over-the-spot style
See: |<A HREF="mbyte.html#xim-input-style">xim-input-style</A>|
For a long time on-the-spot style had been used in the <A HREF="gui_x11.html#GTK">GTK</A> version of
vim, however, <A HREF="motion.html#it">it</A> is known that <A HREF="motion.html#it">it</A> causes troubles when using mappings,
|<A HREF="repeat.html#single-repeat">single-repeat</A>|, etc. Therefore over-the-spot style becomes the
default now. This should work fine for most people, however if you
have any problem with <A HREF="motion.html#it">it</A>, try using on-the-spot style.
*<A NAME="'include'"></A><B>'include'</B>* *<A NAME="'inc'"></A><B>'inc'</B>*
<A HREF="#'include'">'include'</A> <A HREF="#'inc'">'inc'</A> <A HREF="eval.html#string">string</A> (default "^\s*#\s*include")
global or local to buffer |<A HREF="#global-local">global-local</A>|
{not in Vi}
{not available when compiled without the
|<A HREF="various.html#+find_in_path">+find_in_path</A>| feature}
<A HREF="pattern.html#Pattern">Pattern</A> to be used to find an include command. It is a search
pattern, just like for the "<A HREF="pattern.html#/">/</A>" command (See |<A HREF="pattern.html#pattern">pattern</A>|). The default
value is for C programs. This option is used for the commands "<A HREF="tagsrch.html#[i">[i</A>",
"<A HREF="tagsrch.html#]I">]I</A>", "<A HREF="tagsrch.html#[d">[d</A>", etc.
Normally the <A HREF="#'isfname'">'isfname'</A> option is used to recognize the file name that
comes after the matched <A HREF="pattern.html#pattern">pattern</A>. But if "\zs" appears in the <A HREF="pattern.html#pattern">pattern</A>
then the text matched from "\zs" to the end, or until "\ze" if <A HREF="motion.html#it">it</A>
appears, is used <A HREF="motion.html#as">as</A> the file name. Use this to include characters
that are not in <A HREF="#'isfname'">'isfname'</A>, such <A HREF="motion.html#as">as</A> a space. You can then use
<A HREF="#'includeexpr'">'includeexpr'</A> to process the matched text.
See |<A HREF="#option-backslash">option-backslash</A>| about including spaces and backslashes.
*<A NAME="'includeexpr'"></A><B>'includeexpr'</B>* *<A NAME="'inex'"></A><B>'inex'</B>*
<A HREF="#'includeexpr'">'includeexpr'</A> <A HREF="#'inex'">'inex'</A> <A HREF="eval.html#string">string</A> (default "")
local to buffer
{not in Vi}
{not available when compiled without the
|<A HREF="various.html#+find_in_path">+find_in_path</A>| or |<A HREF="various.html#+eval">+eval</A>| features}
Expression to be used to transform the <A HREF="eval.html#string">string</A> found with the <A HREF="#'include'">'include'</A>
option to a file name. Mostly useful to change "<A HREF="repeat.html#.">.</A>" to "<A HREF="pattern.html#/">/</A>" for Java:
<B> :set includeexpr=substitute(v:fname,'\\.','/','g')</B>
The "v:fname" variable will be set to the file name that was detected.
Also used for the |<A HREF="editing.html#gf">gf</A>| command if an unmodified file name can't be
found. Allows doing "<A HREF="editing.html#gf">gf</A>" on the name after an <A HREF="#'include'">'include'</A> statement.
Also used for |<A HREF="cmdline.html#<cfile>"><cfile></A>|.
The <A HREF="eval.html#expression">expression</A> will be evaluated in the |<A HREF="eval.html#sandbox">sandbox</A>| when set from a
<A HREF="#modeline">modeline</A>, see |<A HREF="eval.html#sandbox-option">sandbox-option</A>|.
It is not allowed to change text or jump to another <A HREF="windows.html#window">window</A> while
evaluating <A HREF="#'includeexpr'">'includeexpr'</A> |<A HREF="eval.html#textlock">textlock</A>|.
*<A NAME="'incsearch'"></A><B>'incsearch'</B>* *<A NAME="'is'"></A><B>'is'</B>* *<A NAME="'noincsearch'"></A><B>'noincsearch'</B>* *<A NAME="'nois'"></A><B>'nois'</B>*
<A HREF="#'incsearch'">'incsearch'</A> <A HREF="#'is'">'is'</A> <A HREF="#boolean">boolean</A> (default off, set in |<A HREF="defaults.html">defaults.vim</A>| if the
<A HREF="various.html#+reltime">+reltime</A> feature is supported)
global
{not in Vi}
{not available when compiled without the
|<A HREF="various.html#+extra_search">+extra_search</A>| features}
While typing a search command, show where the <A HREF="pattern.html#pattern">pattern</A>, <A HREF="motion.html#as">as</A> <A HREF="motion.html#it">it</A> was typed
so far, matches. The matched <A HREF="eval.html#string">string</A> is highlighted. If the <A HREF="pattern.html#pattern">pattern</A>
is invalid or not found, nothing is shown. The screen will be updated
often, this is only useful on fast terminals.
Note that the match will be shown, but the cursor will return to its
original position when no match is found and when pressing <A HREF="intro.html#<Esc>"><Esc></A>. You
still need to finish the search command with <A HREF="intro.html#<Enter>"><Enter></A> to move the
cursor to the match.
You can use the <A HREF="editing.html#CTRL-G">CTRL-G</A> and <A HREF="tagsrch.html#CTRL-T">CTRL-T</A> keys to move to the next and
previous match. |<A HREF="cmdline.html#c_CTRL-G">c_CTRL-G</A>| |<A HREF="cmdline.html#c_CTRL-T">c_CTRL-T</A>|
When compiled with the |<A HREF="various.html#+reltime">+reltime</A>| feature Vim only searches for about
half a second. With a complicated <A HREF="pattern.html#pattern">pattern</A> and/or a lot of text the
match may not be found. This is to avoid that Vim hangs while you
are typing the <A HREF="pattern.html#pattern">pattern</A>.
The highlighting can be set with the '<A HREF="insert.html#i">i</A>' flag in <A HREF="#'highlight'">'highlight'</A>.
When <A HREF="#'hlsearch'">'hlsearch'</A> is on, all matched strings are highlighted too while
typing a search command. See also: <A HREF="#'hlsearch'">'hlsearch'</A>.
If you don't want turn <A HREF="#'hlsearch'">'hlsearch'</A> on, but want to highlight all matches
while searching, you can turn on and off <A HREF="#'hlsearch'">'hlsearch'</A> with autocmd.
Example:
<B> augroup vimrc-incsearch-highlight</B>
<B> autocmd!</B>
<B> autocmd CmdlineEnter /,\? :set hlsearch</B>
<B> autocmd CmdlineLeave /,\? :set nohlsearch</B>
<B> augroup END</B>
<A HREF="various.html#CTRL-L">CTRL-L</A> can be used to add one character from after the current match
to the command line. If <A HREF="#'ignorecase'">'ignorecase'</A> and <A HREF="#'smartcase'">'smartcase'</A> are set and the
command line has no <A HREF="change.html#uppercase">uppercase</A> characters, the added character is
converted to <A HREF="change.html#lowercase">lowercase</A>.
<A HREF="undo.html#CTRL-R">CTRL-R</A> <A HREF="index.html#CTRL-W">CTRL-W</A> can be used to add the <A HREF="motion.html#word">word</A> at the end of the current
match, excluding the characters that were already typed.
NOTE: This option is reset when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'indentexpr'"></A><B>'indentexpr'</B>* *<A NAME="'inde'"></A><B>'inde'</B>*
<A HREF="#'indentexpr'">'indentexpr'</A> <A HREF="#'inde'">'inde'</A> <A HREF="eval.html#string">string</A> (default "")
local to buffer
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+cindent">+cindent</A>|
or |<A HREF="various.html#+eval">+eval</A>| features}
Expression which is evaluated to obtain the proper indent for a line.
It is used when a new line is created, for the |<A HREF="change.html#=">=</A>| <A HREF="motion.html#operator">operator</A> and
in <A HREF="insert.html#Insert">Insert</A> mode <A HREF="motion.html#as">as</A> specified with the <A HREF="#'indentkeys'">'indentkeys'</A> option.
When this option is not empty, <A HREF="motion.html#it">it</A> overrules the <A HREF="#'cindent'">'cindent'</A> and
<A HREF="#'smartindent'">'smartindent'</A> indenting. When <A HREF="#'lisp'">'lisp'</A> is set, this option is
overridden by the Lisp indentation algorithm.
When <A HREF="#'paste'">'paste'</A> is set this option is not used for indenting.
The <A HREF="eval.html#expression">expression</A> is evaluated with |<A HREF="eval.html#v:lnum">v:lnum</A>| set to the line number for
which the indent is to be computed. The cursor is also in this line
when the <A HREF="eval.html#expression">expression</A> is evaluated (but <A HREF="motion.html#it">it</A> may be moved around).
The <A HREF="eval.html#expression">expression</A> must return the number of spaces worth of indent. It
can return "-1" to keep the current indent (this means <A HREF="#'autoindent'">'autoindent'</A> is
used for the indent).
Functions useful for computing the indent are |<A HREF="eval.html#indent()">indent()</A>|, |<A HREF="eval.html#cindent()">cindent()</A>|
and |<A HREF="eval.html#lispindent()">lispindent()</A>|.
The evaluation of the <A HREF="eval.html#expression">expression</A> must not have side effects! It must
not change the text, jump to another <A HREF="windows.html#window">window</A>, etc. Afterwards the
cursor position is always restored, thus the cursor may be moved.
Normally this option would be set to call a function:
<B> :set indentexpr=GetMyIndent()</B>
Error <A HREF="message.html#messages">messages</A> will be suppressed, unless the <A HREF="#'debug'">'debug'</A> option contains
"msg".
See |<A HREF="indent.html#indent-expression">indent-expression</A>|.
NOTE: This option is set to "" when <A HREF="#'compatible'">'compatible'</A> is set.
The <A HREF="eval.html#expression">expression</A> will be evaluated in the |<A HREF="eval.html#sandbox">sandbox</A>| when set from a
<A HREF="#modeline">modeline</A>, see |<A HREF="eval.html#sandbox-option">sandbox-option</A>|.
It is not allowed to change text or jump to another <A HREF="windows.html#window">window</A> while
evaluating <A HREF="#'indentexpr'">'indentexpr'</A> |<A HREF="eval.html#textlock">textlock</A>|.
*<A NAME="'indentkeys'"></A><B>'indentkeys'</B>* *<A NAME="'indk'"></A><B>'indk'</B>*
<A HREF="#'indentkeys'">'indentkeys'</A> <A HREF="#'indk'">'indk'</A> <A HREF="eval.html#string">string</A> (default "0{,0},:,0#,!^F,o,O,e")
local to buffer
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+cindent">+cindent</A>|
feature}
A <A HREF="eval.html#list">list</A> of keys that, when typed in <A HREF="insert.html#Insert">Insert</A> mode, cause reindenting of
the current line. Only happens if <A HREF="#'indentexpr'">'indentexpr'</A> isn't empty.
The format is identical to <A HREF="#'cinkeys'">'cinkeys'</A>, see |<A HREF="indent.html#indentkeys-format">indentkeys-format</A>|.
See |<A HREF="indent.html#C-indenting">C-indenting</A>| and |<A HREF="indent.html#indent-expression">indent-expression</A>|.
*<A NAME="'infercase'"></A><B>'infercase'</B>* *<A NAME="'inf'"></A><B>'inf'</B>* *<A NAME="'noinfercase'"></A><B>'noinfercase'</B>* *<A NAME="'noinf'"></A><B>'noinf'</B>*
<A HREF="#'infercase'">'infercase'</A> <A HREF="#'inf'">'inf'</A> <A HREF="#boolean">boolean</A> (default off)
local to buffer
{not in Vi}
When doing keyword completion in insert mode |<A HREF="insert.html#ins-completion">ins-completion</A>|, and
<A HREF="#'ignorecase'">'ignorecase'</A> is also on, the <A HREF="change.html#case">case</A> of the match is adjusted depending
on the typed text. If the typed text contains a <A HREF="change.html#lowercase">lowercase</A> <A HREF="print.html#letter">letter</A>
where the match has an upper <A HREF="change.html#case">case</A> <A HREF="print.html#letter">letter</A>, the completed part is made
<A HREF="change.html#lowercase">lowercase</A>. If the typed text has no <A HREF="change.html#lowercase">lowercase</A> letters and the match
has a <A HREF="change.html#lowercase">lowercase</A> <A HREF="print.html#letter">letter</A> where the typed text has an <A HREF="change.html#uppercase">uppercase</A> <A HREF="print.html#letter">letter</A>,
and there is a <A HREF="print.html#letter">letter</A> before <A HREF="motion.html#it">it</A>, the completed part is made <A HREF="change.html#uppercase">uppercase</A>.
With <A HREF="#'noinfercase'">'noinfercase'</A> the match is used as-is.
*<A NAME="'insertmode'"></A><B>'insertmode'</B>* *<A NAME="'im'"></A><B>'im'</B>* *<A NAME="'noinsertmode'"></A><B>'noinsertmode'</B>* *<A NAME="'noim'"></A><B>'noim'</B>*
<A HREF="#'insertmode'">'insertmode'</A> <A HREF="#'im'">'im'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
Makes Vim work in a way that <A HREF="insert.html#Insert">Insert</A> mode is the default mode. Useful
if you want to use Vim <A HREF="motion.html#as">as</A> a modeless editor. Used for |<A HREF="starting.html#evim">evim</A>|.
These <A HREF="insert.html#Insert">Insert</A> mode commands will be useful:
- Use the cursor keys to move around.
- Use CTRL-O to execute one <A HREF="intro.html#Normal">Normal</A> mode command |<A HREF="insert.html#i_CTRL-O">i_CTRL-O</A>|. When
this is a <A HREF="map.html#mapping">mapping</A>, <A HREF="motion.html#it">it</A> is executed <A HREF="motion.html#as">as</A> if <A HREF="#'insertmode'">'insertmode'</A> was off.
<A HREF="intro.html#Normal">Normal</A> mode remains active until the <A HREF="map.html#mapping">mapping</A> is finished.
- Use <A HREF="various.html#CTRL-L">CTRL-L</A> to execute a number of <A HREF="intro.html#Normal">Normal</A> mode commands, then use
<A HREF="intro.html#<Esc>"><Esc></A> to get back to <A HREF="insert.html#Insert">Insert</A> mode. Note that <A HREF="various.html#CTRL-L">CTRL-L</A> moves the cursor
left, like <A HREF="intro.html#<Esc>"><Esc></A> does when <A HREF="#'insertmode'">'insertmode'</A> isn't set. |<A HREF="insert.html#i_CTRL-L">i_CTRL-L</A>|
These items change when <A HREF="#'insertmode'">'insertmode'</A> is set:
- when starting to edit of a file, Vim goes to <A HREF="insert.html#Insert">Insert</A> mode.
- <A HREF="intro.html#<Esc>"><Esc></A> in <A HREF="insert.html#Insert">Insert</A> mode is a no-op and beeps.
- <A HREF="intro.html#<Esc>"><Esc></A> in <A HREF="intro.html#Normal">Normal</A> mode makes Vim go to <A HREF="insert.html#Insert">Insert</A> mode.
- <A HREF="various.html#CTRL-L">CTRL-L</A> in <A HREF="insert.html#Insert">Insert</A> mode is a command, <A HREF="motion.html#it">it</A> is not inserted.
- CTRL-Z in <A HREF="insert.html#Insert">Insert</A> mode suspends Vim, see |<A HREF="starting.html#CTRL-Z">CTRL-Z</A>|. *<A NAME="i_CTRL-Z"></A><B>i_CTRL-Z</B>*
However, when <A HREF="intro.html#<Esc>"><Esc></A> is used inside a <A HREF="map.html#mapping">mapping</A>, <A HREF="motion.html#it">it</A> behaves like
<A HREF="#'insertmode'">'insertmode'</A> was not set. This was done to be able to use the same
mappings with <A HREF="#'insertmode'">'insertmode'</A> set or not set.
When executing commands with |<A HREF="various.html#:normal">:normal</A>| <A HREF="#'insertmode'">'insertmode'</A> is not used.
NOTE: This option is reset when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'isfname'"></A><B>'isfname'</B>* *<A NAME="'isf'"></A><B>'isf'</B>*
<A HREF="#'isfname'">'isfname'</A> <A HREF="#'isf'">'isf'</A> <A HREF="eval.html#string">string</A> (default for <A HREF="os_msdos.html#MS-DOS">MS-DOS</A>, <A HREF="os_win32.html#Win32">Win32</A> and <A HREF="os_os2.html#OS/2">OS/2</A>:
"@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
for <A HREF="os_vms.html#VMS">VMS</A>: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
global
{not in Vi}
The characters specified by this option are included in file names and
path names. Filenames are used for commands like "<A HREF="editing.html#gf">gf</A>", "<A HREF="tagsrch.html#[i">[i</A>" and in
the <A HREF="tagsrch.html#tags">tags</A> file. It is also used for "\f" in a |<A HREF="pattern.html#pattern">pattern</A>|.
Multi-byte characters 256 and above are always included, only the
characters up to 255 are specified with this option.
For <A HREF="mbyte.html#UTF-8">UTF-8</A> the characters 0xa0 to 0xff are included <A HREF="motion.html#as">as</A> well.
Think <A HREF="if_cscop.html#twice">twice</A> before adding white space to this option. Although a
space may appear inside a file name, the effect will be that Vim
doesn't know where a file name starts or ends when doing completion.
It most likely works better without a space in <A HREF="#'isfname'">'isfname'</A>.
Note that on systems using a <A HREF="intro.html#backslash">backslash</A> <A HREF="motion.html#as">as</A> path separator, Vim tries to
<A HREF="diff.html#do">do</A> its best to make <A HREF="motion.html#it">it</A> work <A HREF="motion.html#as">as</A> you would expect. That is a bit
tricky, since <A HREF="intro.html#Vi">Vi</A> originally used the <A HREF="intro.html#backslash">backslash</A> to <A HREF="intro.html#escape">escape</A> special
characters. Vim will not remove a <A HREF="intro.html#backslash">backslash</A> in front of a normal file
name character on these systems, but <A HREF="motion.html#it">it</A> will on <A HREF="os_unix.html#Unix">Unix</A> and alikes. The
'<A HREF="change.html#&">&</A>' and '<A HREF="motion.html#^">^</A>' are not included by default, because these are special for
cmd.exe.
The format of this option is a <A HREF="eval.html#list">list</A> of parts, separated with commas.
Each part can be a single character number or a range. A range is two
character numbers with '<A HREF="motion.html#-">-</A>' in between. A character number can be a
decimal number between 0 and 255 or the ASCII character itself (does
not work for digits). Example:
"_,-,128-140,#-43" (include '<A HREF="motion.html#_">_</A>' and '<A HREF="motion.html#-">-</A>' and the range
128 to 140 and '<A HREF="pattern.html##">#</A>' to 43)
If a part starts with '<A HREF="motion.html#^">^</A>', the following character number or range
will be excluded from the option. The option is interpreted from left
to right. Put the excluded character after the range where <A HREF="motion.html#it">it</A> is
included. To include '<A HREF="motion.html#^">^</A>' itself use <A HREF="motion.html#it">it</A> <A HREF="motion.html#as">as</A> the last character of the
option or the end of a range. Example:
"^a-z,#,^" (exclude '<A HREF="insert.html#a">a</A>' to '<A HREF="index.html#z">z</A>', include '<A HREF="pattern.html##">#</A>' and '<A HREF="motion.html#^">^</A>')
If the character is '<A HREF="repeat.html#@">@</A>', all characters where isalpha() returns <A HREF="eval.html#TRUE">TRUE</A>
are included. Normally these are the characters a to <A HREF="index.html#z">z</A> and A to Z,
plus accented characters. To include '<A HREF="repeat.html#@">@</A>' itself use "@-@". Examples:
"@,^a-z" All alphabetic characters, excluding lower
<A HREF="change.html#case">case</A> ASCII letters.
"a-z,A-Z,@-@" All letters plus the '<A HREF="repeat.html#@">@</A>' character.
A comma can be included by using <A HREF="motion.html#it">it</A> where a character number is
expected. Example:
"48-57,,,_" Digits, comma and underscore.
A comma can be excluded by prepending a '<A HREF="motion.html#^">^</A>'. Example:
" -~,^,,9" All characters from space to '<A HREF="change.html#~">~</A>', excluding
comma, plus <A HREF="motion.html#<Tab>"><Tab></A>.
See |<A HREF="#option-backslash">option-backslash</A>| about including spaces and backslashes.
*<A NAME="'isident'"></A><B>'isident'</B>* *<A NAME="'isi'"></A><B>'isi'</B>*
<A HREF="#'isident'">'isident'</A> <A HREF="#'isi'">'isi'</A> <A HREF="eval.html#string">string</A> (default for <A HREF="os_msdos.html#MS-DOS">MS-DOS</A>, <A HREF="os_win32.html#Win32">Win32</A> and <A HREF="os_os2.html#OS/2">OS/2</A>:
"@,48-57,_,128-167,224-235"
otherwise: "@,48-57,_,192-255")
global
{not in Vi}
The characters given by this option are included in identifiers.
Identifiers are used in recognizing environment <A HREF="eval.html#variables">variables</A> and after a
match of the <A HREF="#'define'">'define'</A> option. It is also used for "\i" in a
|<A HREF="pattern.html#pattern">pattern</A>|. See <A HREF="#'isfname'">'isfname'</A> for a description of the format of this
option.
Careful: If you change this option, <A HREF="motion.html#it">it</A> might break expanding
environment <A HREF="eval.html#variables">variables</A>. E.g., when '<A HREF="pattern.html#/">/</A>' is included and Vim tries to
expand "$HOME/.viminfo". Maybe you should change <A HREF="#'iskeyword'">'iskeyword'</A> instead.
*<A NAME="'iskeyword'"></A><B>'iskeyword'</B>* *<A NAME="'isk'"></A><B>'isk'</B>*
<A HREF="#'iskeyword'">'iskeyword'</A> <A HREF="#'isk'">'isk'</A> <A HREF="eval.html#string">string</A> (Vim default for <A HREF="os_msdos.html#MS-DOS">MS-DOS</A> and <A HREF="os_win32.html#Win32">Win32</A>:
"@,48-57,_,128-167,224-235"
otherwise: "@,48-57,_,192-255"
<A HREF="intro.html#Vi">Vi</A> default: "@,48-57,_")
local to buffer
{not in Vi}
Keywords are used in searching and recognizing with many commands:
"<A HREF="motion.html#w">w</A>", "*", "<A HREF="tagsrch.html#[i">[i</A>", etc. It is also used for "\k" in a |<A HREF="pattern.html#pattern">pattern</A>|. See
<A HREF="#'isfname'">'isfname'</A> for a description of the format of this option. For C
programs you could use "a-z,A-Z,48-57,_,.,-,>".
For a help file <A HREF="motion.html#it">it</A> is set to all non-blank printable characters except
'*', '"'' and '|' (so that <A HREF="tagsrch.html#CTRL-]">CTRL-]</A> on a command finds the help for that
command).
When the <A HREF="#'lisp'">'lisp'</A> option is on the '<A HREF="motion.html#-">-</A>' character is always included.
This option also influences <A HREF="syntax.html#syntax">syntax</A> highlighting, unless the <A HREF="syntax.html#syntax">syntax</A>
uses |<A HREF="syntax.html#:syn-iskeyword">:syn-iskeyword</A>|.
NOTE: This option is set to the <A HREF="intro.html#Vi">Vi</A> default value when <A HREF="#'compatible'">'compatible'</A> is
set and to the Vim default value when <A HREF="#'compatible'">'compatible'</A> is reset.
*<A NAME="'isprint'"></A><B>'isprint'</B>* *<A NAME="'isp'"></A><B>'isp'</B>*
<A HREF="#'isprint'">'isprint'</A> <A HREF="#'isp'">'isp'</A> <A HREF="eval.html#string">string</A> (default for <A HREF="os_msdos.html#MS-DOS">MS-DOS</A>, <A HREF="os_win32.html#Win32">Win32</A>, <A HREF="os_os2.html#OS/2">OS/2</A> and <A HREF="os_mac.html#Macintosh">Macintosh</A>:
"@,~-255"; otherwise: "@,161-255")
global
{not in Vi}
The characters given by this option are displayed directly on the
screen. It is also used for "\p" in a |<A HREF="pattern.html#pattern">pattern</A>|. The characters from
space (ASCII 32) to '<A HREF="change.html#~">~</A>' (ASCII 126) are always displayed directly,
even when they are not included in <A HREF="#'isprint'">'isprint'</A> or excluded. See
<A HREF="#'isfname'">'isfname'</A> for a description of the format of this option.
Non-printable characters are displayed with two characters:
0 - 31 "^@" - "^_"
32 - 126 always single characters
127 "^?"
128 - 159 "~@" - "~_"
160 - 254 "| " - "|~"
255 "~?"
When <A HREF="#'encoding'">'encoding'</A> is a <A HREF="mbyte.html#Unicode">Unicode</A> one, illegal bytes from 128 to 255 are
displayed <A HREF="motion.html#as">as</A> <xx>, with the hexadecimal value of the byte.
When <A HREF="#'display'">'display'</A> contains "uhex" all unprintable characters are
displayed <A HREF="motion.html#as">as</A> <xx>.
The SpecialKey highlighting will be used for unprintable characters.
|<A HREF="syntax.html#hl-SpecialKey">hl-SpecialKey</A>|
Multi-byte characters 256 and above are always included, only the
characters up to 255 are specified with this option. When a character
is printable but <A HREF="motion.html#it">it</A> is not available in the current font, a
replacement character will be shown.
Unprintable and zero-width <A HREF="mbyte.html#Unicode">Unicode</A> characters are displayed <A HREF="motion.html#as">as</A> <xxxx>.
There is no option to specify these characters.
*<A NAME="'joinspaces'"></A><B>'joinspaces'</B>* *<A NAME="'js'"></A><B>'js'</B>* *<A NAME="'nojoinspaces'"></A><B>'nojoinspaces'</B>* *<A NAME="'nojs'"></A><B>'nojs'</B>*
<A HREF="#'joinspaces'">'joinspaces'</A> <A HREF="#'js'">'js'</A> <A HREF="#boolean">boolean</A> (default on)
global
{not in Vi}
<A HREF="insert.html#Insert">Insert</A> two spaces after a '<A HREF="repeat.html#.">.</A>', '<A HREF="pattern.html#?">?</A>' and '<A HREF="change.html#!">!</A>' with a join command.
When <A HREF="#'cpoptions'">'cpoptions'</A> includes the '<A HREF="motion.html#j">j</A>' flag, only <A HREF="diff.html#do">do</A> this after a '<A HREF="repeat.html#.">.</A>'.
Otherwise only one space is inserted.
NOTE: This option is set when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'key'"></A><B>'key'</B>*
<A HREF="#'key'">'key'</A> <A HREF="eval.html#string">string</A> (default "")
local to buffer
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+cryptv">+cryptv</A>|
feature}
The key that is used for encrypting and decrypting the current buffer.
See |<A HREF="editing.html#encryption">encryption</A>| and <A HREF="#'cryptmethod'">'cryptmethod'</A>.
Careful: Do not set the key value by hand, someone might see the typed
key. Use the |<A HREF="editing.html#:X">:X</A>| command. But you can make <A HREF="#'key'">'key'</A> empty:
<B> :set key=</B>
It is not possible to get the value of this option with "<A HREF="#:set">:set</A> <A HREF="#'key'">key</A>" or
"echo &key". This is to avoid showing <A HREF="motion.html#it">it</A> to someone who shouldn't
know. It also means you cannot see <A HREF="motion.html#it">it</A> yourself once you have set <A HREF="motion.html#it">it</A>,
be careful not to make a typing error!
You can use "&key" in an <A HREF="eval.html#expression">expression</A> to detect whether <A HREF="editing.html#encryption">encryption</A> is
enabled. When <A HREF="#'key'">'key'</A> is set <A HREF="motion.html#it">it</A> returns "*****" (five stars).
*<A NAME="'keymap'"></A><B>'keymap'</B>* *<A NAME="'kmp'"></A><B>'kmp'</B>* *<A NAME="E544"></A><B>E544</B>*
<A HREF="#'keymap'">'keymap'</A> <A HREF="#'kmp'">'kmp'</A> <A HREF="eval.html#string">string</A> (default "")
local to buffer
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+keymap">+keymap</A>|
feature}
Name of a keyboard <A HREF="map.html#mapping">mapping</A>. See |<A HREF="mbyte.html#mbyte-keymap">mbyte-keymap</A>|.
Setting this option to a valid keymap name has the side effect of
setting <A HREF="#'iminsert'">'iminsert'</A> to one, so that the keymap becomes effective.
<A HREF="#'imsearch'">'imsearch'</A> is also set to one, unless <A HREF="motion.html#it">it</A> was -1
Only normal file name characters can be used, "/\*?[|<>" are illegal.
*<A NAME="'keymodel'"></A><B>'keymodel'</B>* *<A NAME="'km'"></A><B>'km'</B>*
<A HREF="#'keymodel'">'keymodel'</A> <A HREF="#'km'">'km'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not in Vi}
<A HREF="eval.html#List">List</A> of comma separated words, which enable special things that keys
can <A HREF="diff.html#do">do</A>. These values can be used:
startsel Using a shifted special key starts selection (either
<A HREF="visual.html#Select">Select</A> mode or <A HREF="visual.html#Visual">Visual</A> mode, depending on "key" being
present in <A HREF="#'selectmode'">'selectmode'</A>).
stopsel Using a not-shifted special key stops selection.
<A HREF="eval.html#Special">Special</A> keys in this context are the cursor keys, <A HREF="motion.html#<End>"><End></A>, <A HREF="motion.html#<Home>"><Home></A>,
<A HREF="scroll.html#<PageUp>"><PageUp></A> and <A HREF="scroll.html#<PageDown>"><PageDown></A>.
The <A HREF="#'keymodel'">'keymodel'</A> option is set by the |<A HREF="gui.html#:behave">:behave</A>| command.
*<A NAME="'keywordprg'"></A><B>'keywordprg'</B>* *<A NAME="'kp'"></A><B>'kp'</B>*
<A HREF="#'keywordprg'">'keywordprg'</A> <A HREF="#'kp'">'kp'</A> <A HREF="eval.html#string">string</A> (default "man" or "man -s", <A HREF="os_dos.html#DOS">DOS</A>: "<A HREF="helphelp.html#:help">:help</A>",
<A HREF="os_vms.html#VMS">VMS</A>: "help")
global or local to buffer |<A HREF="#global-local">global-local</A>|
{not in Vi}
Program to use for the |<A HREF="various.html#K">K</A>| command. Environment <A HREF="eval.html#variables">variables</A> are
expanded |<A HREF="#:set_env">:set_env</A>|. "<A HREF="helphelp.html#:help">:help</A>" may be used to access the Vim internal
help. (Note that previously setting the global option to the empty
value did this, which is now deprecated.)
When the first character is "<A HREF="cmdline.html#:">:</A>", the command is invoked <A HREF="motion.html#as">as</A> a Vim
<A HREF="intro.html#Ex">Ex</A> command prefixed with <A HREF="intro.html#[count]">[count]</A>.
When "man", "man -s" or an <A HREF="intro.html#Ex">Ex</A> command is used, Vim will automatically
translate a <A HREF="intro.html#count">count</A> for the "<A HREF="various.html#K">K</A>" command and pass <A HREF="motion.html#it">it</A> <A HREF="motion.html#as">as</A> the first
argument. For "man -s" the "<A HREF="starting.html#-s">-s</A>" is removed when there is no <A HREF="intro.html#count">count</A>.
See |<A HREF="#option-backslash">option-backslash</A>| about including spaces and backslashes.
Example:
<B> :set keywordprg=man\ -s</B>
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'langmap'"></A><B>'langmap'</B>* *<A NAME="'lmap'"></A><B>'lmap'</B>* *<A NAME="E357"></A><B>E357</B>* *<A NAME="E358"></A><B>E358</B>*
<A HREF="#'langmap'">'langmap'</A> <A HREF="#'lmap'">'lmap'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+langmap">+langmap</A>|
feature}
This option allows switching your keyboard into a special language
mode. When you are typing text in <A HREF="insert.html#Insert">Insert</A> mode the characters are
inserted directly. When in <A HREF="intro.html#Normal">Normal</A> mode the <A HREF="#'langmap'">'langmap'</A> option takes
care of translating these special characters to the original meaning
of the key. This means you don't have to change the keyboard mode to
be able to execute <A HREF="intro.html#Normal">Normal</A> mode commands.
This is the opposite of the <A HREF="#'keymap'">'keymap'</A> option, where characters are
mapped in <A HREF="insert.html#Insert">Insert</A> mode.
Also consider resetting <A HREF="#'langremap'">'langremap'</A> to avoid <A HREF="#'langmap'">'langmap'</A> applies to
characters resulting from a <A HREF="map.html#mapping">mapping</A>.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
Example (for Greek, in UTF-8): *<A NAME="greek"></A><B>greek</B>*
<B> :set langmap=ΑA,ΒB,ΨC,ΔD,ΕE,ΦF,ΓG,ΗH,ΙI,ΞJ,ΚK,ΛL,ΜM,ΝN,ΟO,ΠP,QQ,ΡR,ΣS,ΤT,ΘU,ΩV,WW,ΧX,ΥY,ΖZ,αa,βb,ψc,δd,εe,φf,γg,ηh,ιi,ξj,κk,λl,μm,νn,οo,πp,qq,ρr,σs,τt,θu,ωv,ςw,χx,υy,ζz</B>
Example (exchanges meaning of <A HREF="index.html#z">z</A> and <A HREF="change.html#y">y</A> for commands):
<B> :set langmap=zy,yz,ZY,YZ</B>
The <A HREF="#'langmap'">'langmap'</A> option is a <A HREF="eval.html#list">list</A> of parts, separated with commas. Each
part can be in one of two forms:
1. A <A HREF="eval.html#list">list</A> of pairs. Each pair is a "from" character immediately
followed by the "to" character. Examples: "aA", "aAbBcC".
2. A <A HREF="eval.html#list">list</A> of "from" characters, a semi-colon and a <A HREF="eval.html#list">list</A> of "to"
characters. Example: "abc;ABC"
Example: "aA,fgh;FGH,cCdDeE"
<A HREF="eval.html#Special">Special</A> characters need to be preceded with a <A HREF="intro.html#backslash">backslash</A>. These are
"<A HREF="motion.html#;">;</A>", '<A HREF="motion.html#,">,</A>' and <A HREF="intro.html#backslash">backslash</A> itself.
This will allow you to activate vim actions without having to switch
back and forth between the languages. Your language characters will
be understood <A HREF="motion.html#as">as</A> normal vim English characters (according to the
langmap mappings) in the following cases:
<A HREF="insert.html#o">o</A> Normal/Visual mode (commands, buffer/register names, user mappings)
<A HREF="insert.html#o">o</A> Insert/Replace Mode: Register names after <A HREF="undo.html#CTRL-R">CTRL-R</A>
<A HREF="insert.html#o">o</A> Insert/Replace Mode: Mappings
Characters entered in <A HREF="cmdline.html#Command-line">Command-line</A> mode will NOT be affected by
this option. Note that this option can be changed at any time
allowing to switch between mappings for different languages/encodings.
Use a <A HREF="map.html#mapping">mapping</A> to avoid having to type <A HREF="motion.html#it">it</A> each time!
*<A NAME="'langmenu'"></A><B>'langmenu'</B>* *<A NAME="'lm'"></A><B>'lm'</B>*
<A HREF="#'langmenu'">'langmenu'</A> <A HREF="#'lm'">'lm'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+menu">+menu</A>| and
|<A HREF="various.html#+multi_lang">+multi_lang</A>| features}
Language to use for menu translation. Tells which file is loaded
from the "lang" directory in <A HREF="#'runtimepath'">'runtimepath'</A>:
<B> "lang/menu_" . &langmenu . ".vim"</B>
(without the spaces). For example, to always use the Dutch <A HREF="gui.html#menus">menus</A>, no
matter what $LANG is set to:
<B> :set langmenu=nl_NL.ISO_8859-1</B>
When <A HREF="#'langmenu'">'langmenu'</A> is empty, |<A HREF="eval.html#v:lang">v:lang</A>| is used.
Only normal file name characters can be used, "/\*?[|<>" are illegal.
If your $LANG is set to a non-English language but you <A HREF="diff.html#do">do</A> want to use
the English <A HREF="gui.html#menus">menus</A>:
<B> :set langmenu=none</B>
This option must be set before loading <A HREF="gui.html#menus">menus</A>, switching on <A HREF="filetype.html#filetype">filetype</A>
detection or <A HREF="syntax.html#syntax">syntax</A> highlighting. Once the <A HREF="gui.html#menus">menus</A> are defined setting
this option has no effect. But you could <A HREF="diff.html#do">do</A> this:
<B> :source $VIMRUNTIME/delmenu.vim</B>
<B> :set langmenu=de_DE.ISO_8859-1</B>
<B> :source $VIMRUNTIME/menu.vim</B>
Warning: This deletes all <A HREF="gui.html#menus">menus</A> that you defined yourself!
*<A NAME="'langnoremap'"></A><B>'langnoremap'</B>* *<A NAME="'lnr'"></A><B>'lnr'</B>* *<A NAME="'nolangnoremap'"></A><B>'nolangnoremap'</B>* *<A NAME="'nolnr'"></A><B>'nolnr'</B>*
<A HREF="#'langnoremap'">'langnoremap'</A> <A HREF="#'lnr'">'lnr'</A> <A HREF="#boolean">boolean</A> (default off, set in |<A HREF="defaults.html">defaults.vim</A>|)
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+langmap">+langmap</A>|
feature}
This is just like <A HREF="#'langremap'">'langremap'</A> but with the value inverted. It only
exists for backwards compatibility. When setting <A HREF="#'langremap'">'langremap'</A> then
<A HREF="#'langnoremap'">'langnoremap'</A> is set to the inverted value, and the other way around.
*<A NAME="'langremap'"></A><B>'langremap'</B>* *<A NAME="'lrm'"></A><B>'lrm'</B>* *<A NAME="'nolangremap'"></A><B>'nolangremap'</B>* *<A NAME="'nolrm'"></A><B>'nolrm'</B>*
<A HREF="#'langremap'">'langremap'</A> <A HREF="#'lrm'">'lrm'</A> <A HREF="#boolean">boolean</A> (default on, reset in |<A HREF="defaults.html">defaults.vim</A>|)
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+langmap">+langmap</A>|
feature}
When off, setting <A HREF="#'langmap'">'langmap'</A> does not apply to characters resulting from
a <A HREF="map.html#mapping">mapping</A>. This basically means, if you noticed that setting
<A HREF="#'langmap'">'langmap'</A> disables some of your mappings, try resetting this option.
This option defaults to on for backwards compatibility. Set <A HREF="motion.html#it">it</A> off if
that works for you to avoid mappings to break.
*<A NAME="'laststatus'"></A><B>'laststatus'</B>* *<A NAME="'ls'"></A><B>'ls'</B>*
<A HREF="#'laststatus'">'laststatus'</A> <A HREF="#'ls'">'ls'</A> number (default 1)
global
{not in Vi}
The value of this option influences when the last <A HREF="windows.html#window">window</A> will have a
status line:
0: never
1: only if there are at least two <A HREF="windows.html#windows">windows</A>
2: always
The screen looks nicer with a status line if you have several
<A HREF="windows.html#windows">windows</A>, but <A HREF="motion.html#it">it</A> takes another screen line. |<A HREF="windows.html#status-line">status-line</A>|
*<A NAME="'lazyredraw'"></A><B>'lazyredraw'</B>* *<A NAME="'lz'"></A><B>'lz'</B>* *<A NAME="'nolazyredraw'"></A><B>'nolazyredraw'</B>* *<A NAME="'nolz'"></A><B>'nolz'</B>*
<A HREF="#'lazyredraw'">'lazyredraw'</A> <A HREF="#'lz'">'lz'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
When this option is set, the screen will not be redrawn while
executing macros, <A HREF="change.html#registers">registers</A> and other commands that have not been
typed. Also, updating the <A HREF="windows.html#window">window</A> title is postponed. To force an
update use |<A HREF="various.html#:redraw">:redraw</A>|.
*<A NAME="'linebreak'"></A><B>'linebreak'</B>* *<A NAME="'lbr'"></A><B>'lbr'</B>* *<A NAME="'nolinebreak'"></A><B>'nolinebreak'</B>* *<A NAME="'nolbr'"></A><B>'nolbr'</B>*
<A HREF="#'linebreak'">'linebreak'</A> <A HREF="#'lbr'">'lbr'</A> <A HREF="#boolean">boolean</A> (default off)
local to <A HREF="windows.html#window">window</A>
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+linebreak">+linebreak</A>|
feature}
If on, Vim will wrap long lines at a character in <A HREF="#'breakat'">'breakat'</A> rather
than at the last character that fits on the screen. Unlike
<A HREF="#'wrapmargin'">'wrapmargin'</A> and <A HREF="#'textwidth'">'textwidth'</A>, this does not insert <EOL>s in the file,
<A HREF="motion.html#it">it</A> only affects the way the file is displayed, not its contents.
If <A HREF="#'breakindent'">'breakindent'</A> is set, line is visually indented. Then, the value
of <A HREF="#'showbreak'">'showbreak'</A> is used to put in front of wrapped lines. This option
is not used when the <A HREF="#'wrap'">'wrap'</A> option is off.
Note that <A HREF="motion.html#<Tab>"><Tab></A> characters after an <A HREF="intro.html#<EOL>"><EOL></A> are mostly not displayed
with the right amount of white space.
*<A NAME="'lines'"></A><B>'lines'</B>* *<A NAME="E593"></A><B>E593</B>*
<A HREF="#'lines'">'lines'</A> number (default 24 or <A HREF="terminal.html#terminal">terminal</A> height)
global
<A HREF="eval.html#Number">Number</A> of lines of the Vim <A HREF="windows.html#window">window</A>.
Normally you don't need to set this. It is done automatically by the
<A HREF="terminal.html#terminal">terminal</A> <A HREF="starting.html#initialization">initialization</A> code. Also see |<A HREF="vi_diff.html#posix-screen-size">posix-screen-size</A>|.
When Vim is running in the <A HREF="gui.html#GUI">GUI</A> or in a resizable <A HREF="windows.html#window">window</A>, setting this
option will cause the <A HREF="windows.html#window">window</A> size to be changed. When you only want
to use the size for the <A HREF="gui.html#GUI">GUI</A>, put the command in your |<A HREF="gui.html#gvimrc">gvimrc</A>| file.
Vim <A HREF="vi_diff.html#limits">limits</A> the number of lines to what fits on the screen. You can
use this command to get the tallest <A HREF="windows.html#window">window</A> possible:
<B> :set lines=999</B>
Minimum value is 2, maximum value is 1000.
If you get fewer lines than expected, check the <A HREF="#'guiheadroom'">'guiheadroom'</A> option.
When you set this option and Vim is unable to change the physical
number of lines of the display, the display may be messed up.
*<A NAME="'linespace'"></A><B>'linespace'</B>* *<A NAME="'lsp'"></A><B>'lsp'</B>*
<A HREF="#'linespace'">'linespace'</A> <A HREF="#'lsp'">'lsp'</A> number (default 0, 1 for <A HREF="os_win32.html#Win32">Win32</A> <A HREF="gui.html#GUI">GUI</A>)
global
{not in Vi}
{only in the GUI}
<A HREF="eval.html#Number">Number</A> of pixel lines inserted between characters. Useful if the font
uses the full character cell height, making lines touch each other.
When non-zero there is room for underlining.
With some fonts there can be too much room between lines (to have
space for ascents and descents). Then <A HREF="motion.html#it">it</A> makes sense to set
<A HREF="#'linespace'">'linespace'</A> to a negative value. This may cause display problems
though!
*<A NAME="'lisp'"></A><B>'lisp'</B>* *<A NAME="'nolisp'"></A><B>'nolisp'</B>*
<A HREF="#'lisp'">'lisp'</A> <A HREF="#boolean">boolean</A> (default off)
local to buffer
{not available when compiled without the |<A HREF="various.html#+lispindent">+lispindent</A>|
feature}
Lisp mode: When <A HREF="intro.html#<Enter>"><Enter></A> is typed in insert mode set the indent for
the next line to Lisp standards (well, sort of). Also happens with
"<A HREF="change.html#cc">cc</A>" or "<A HREF="change.html#S">S</A>". <A HREF="#'autoindent'">'autoindent'</A> must also be on for this to work. The '<A HREF="change.html#p">p</A>'
flag in <A HREF="#'cpoptions'">'cpoptions'</A> changes the method of indenting: <A HREF="intro.html#Vi">Vi</A> compatible or
better. Also see <A HREF="#'lispwords'">'lispwords'</A>.
The '<A HREF="motion.html#-">-</A>' character is included in keyword characters. Redefines the
"<A HREF="change.html#=">=</A>" <A HREF="motion.html#operator">operator</A> to use this same indentation algorithm rather than
calling an external program if <A HREF="#'equalprg'">'equalprg'</A> is empty.
This option is not used when <A HREF="#'paste'">'paste'</A> is set.
{Vi: Does <A HREF="motion.html#it">it</A> a little bit differently}
*<A NAME="'lispwords'"></A><B>'lispwords'</B>* *<A NAME="'lw'"></A><B>'lw'</B>*
<A HREF="#'lispwords'">'lispwords'</A> <A HREF="#'lw'">'lw'</A> <A HREF="eval.html#string">string</A> (default is very long)
global or local to buffer |<A HREF="#global-local">global-local</A>|
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+lispindent">+lispindent</A>|
feature}
Comma separated <A HREF="eval.html#list">list</A> of words that influence the Lisp indenting.
|<A HREF="#'lisp'">'lisp'</A>|
*<A NAME="'list'"></A><B>'list'</B>* *<A NAME="'nolist'"></A><B>'nolist'</B>*
<A HREF="#'list'">'list'</A> <A HREF="#boolean">boolean</A> (default off)
local to <A HREF="windows.html#window">window</A>
<A HREF="eval.html#List">List</A> mode: Show tabs <A HREF="motion.html#as">as</A> <A HREF="motion.html#CTRL-I">CTRL-I</A> is displayed, display $ after end of
line. Useful to see the difference between tabs and spaces and for
trailing blanks. Further changed by the <A HREF="#'listchars'">'listchars'</A> option.
The cursor is displayed at the start of the space a <A HREF="intro.html#Tab">Tab</A> character
occupies, not at the end <A HREF="motion.html#as">as</A> usual in <A HREF="intro.html#Normal">Normal</A> mode. To get this cursor
position while displaying Tabs with spaces, use:
<B> :set list lcs=tab:\ \ </B>
Note that <A HREF="eval.html#list">list</A> mode will also affect <A HREF="change.html#formatting">formatting</A> (set with <A HREF="#'textwidth'">'textwidth'</A>
or <A HREF="#'wrapmargin'">'wrapmargin'</A>) when <A HREF="#'cpoptions'">'cpoptions'</A> includes '<A HREF="motion.html#L">L</A>'. See <A HREF="#'listchars'">'listchars'</A> for
<A HREF="change.html#changing">changing</A> the way tabs are displayed.
*<A NAME="'listchars'"></A><B>'listchars'</B>* *<A NAME="'lcs'"></A><B>'lcs'</B>*
<A HREF="#'listchars'">'listchars'</A> <A HREF="#'lcs'">'lcs'</A> <A HREF="eval.html#string">string</A> (default "eol:$")
global
{not in Vi}
Strings to use in <A HREF="#'list'">'list'</A> mode and for the |<A HREF="various.html#:list">:list</A>| command. It is a
comma separated <A HREF="eval.html#list">list</A> of <A HREF="eval.html#string">string</A> settings.
*<A NAME="lcs-eol"></A><B>lcs-eol</B>*
eol:c Character to show at the end of each line. When
omitted, there is no extra character at the end of the
line.
*<A NAME="lcs-tab"></A><B>lcs-tab</B>*
tab:xy Two characters to be used to show a <A HREF="intro.html#tab">tab</A>. The first
char is used once. The second char is repeated to
fill the space that the <A HREF="intro.html#tab">tab</A> normally occupies.
"tab:>-" will show a <A HREF="intro.html#tab">tab</A> that takes four spaces <A HREF="motion.html#as">as</A>
">---". When omitted, a <A HREF="intro.html#tab">tab</A> is show <A HREF="motion.html#as">as</A> ^I.
*<A NAME="lcs-space"></A><B>lcs-space</B>*
space:c Character to show for a space. When omitted, spaces
are left blank.
*<A NAME="lcs-trail"></A><B>lcs-trail</B>*
trail:c Character to show for trailing spaces. When omitted,
trailing spaces are blank. Overrides the "space"
setting for trailing spaces.
*<A NAME="lcs-extends"></A><B>lcs-extends</B>*
extends:c Character to show in the last column, when <A HREF="#'wrap'">'wrap'</A> is
off and the line continues beyond the right of the
screen.
*<A NAME="lcs-precedes"></A><B>lcs-precedes</B>*
precedes:c Character to show in the first column, when <A HREF="#'wrap'">'wrap'</A>
is off and there is text preceding the character
visible in the first column.
*<A NAME="lcs-conceal"></A><B>lcs-conceal</B>*
conceal:c Character to show in place of concealed text, when
<A HREF="#'conceallevel'">'conceallevel'</A> is set to 1.
*<A NAME="lcs-nbsp"></A><B>lcs-nbsp</B>*
nbsp:c Character to show for a non-breakable space character
(0xA0 (160 decimal) and U+202F). Left blank when
omitted.
The characters '<A HREF="cmdline.html#:">:</A>' and '<A HREF="motion.html#,">,</A>' should not be used. <A HREF="mbyte.html#UTF-8">UTF-8</A> characters can
be used when <A HREF="#'encoding'">'encoding'</A> is "<A HREF="mbyte.html#utf-8">utf-8</A>", otherwise only printable
characters are allowed. All characters must be single width.
Examples:
<B> :set lcs=tab:>-,trail:-</B>
<B> :set lcs=tab:>-,eol:<,nbsp:%</B>
<B> :set lcs=extends:>,precedes:<</B>
The "NonText" highlighting will be used for "eol", "extends" and
"precedes". "SpecialKey" for "nbsp", "space", "<A HREF="intro.html#tab">tab</A>" and "trail".
|<A HREF="syntax.html#hl-NonText">hl-NonText</A>| |<A HREF="syntax.html#hl-SpecialKey">hl-SpecialKey</A>|
*<A NAME="'lpl'"></A><B>'lpl'</B>* *<A NAME="'nolpl'"></A><B>'nolpl'</B>* *<A NAME="'loadplugins'"></A><B>'loadplugins'</B>* *<A NAME="'noloadplugins'"></A><B>'noloadplugins'</B>*
<A HREF="#'loadplugins'">'loadplugins'</A> <A HREF="#'lpl'">'lpl'</A> <A HREF="#boolean">boolean</A> (default on)
global
{not in Vi}
When on the plugin scripts are loaded when starting up |<A HREF="starting.html#load-plugins">load-plugins</A>|.
This option can be reset in your |<A HREF="starting.html#vimrc">vimrc</A>| file to disable the loading
of plugins.
Note that using the "<A HREF="starting.html#-u">-u</A> NONE", "<A HREF="starting.html#-u">-u</A> DEFAULTS" and "<A HREF="starting.html#--noplugin">--noplugin</A>" command
line arguments reset this option. See |<A HREF="starting.html#-u">-u</A>| and |<A HREF="starting.html#--noplugin">--noplugin</A>|.
*<A NAME="'luadll'"></A><B>'luadll'</B>*
<A HREF="#'luadll'">'luadll'</A> <A HREF="eval.html#string">string</A> (default depends on the build)
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+lua/dyn">+lua/dyn</A>|
feature}
Specifies the name of the <A HREF="if_lua.html#Lua">Lua</A> shared library. The default is
DYNAMIC_LUA_DLL, which was specified at compile time.
Environment <A HREF="eval.html#variables">variables</A> are expanded |<A HREF="#:set_env">:set_env</A>|.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'macatsui'"></A><B>'macatsui'</B>* *<A NAME="'nomacatsui'"></A><B>'nomacatsui'</B>*
<A HREF="#'macatsui'">'macatsui'</A> <A HREF="#boolean">boolean</A> (default on)
global
{only available in <A HREF="os_mac.html#Mac">Mac</A> <A HREF="gui.html#GUI">GUI</A> version}
This is a workaround for when drawing doesn't work properly. When set
and compiled with <A HREF="mbyte.html#multi-byte">multi-byte</A> support ATSUI text drawing is used. When
not set ATSUI text drawing is not used. Switch this option off when
you experience drawing problems. In a future version the problems may
be solved and this option becomes obsolete. Therefore use this method
to unset <A HREF="motion.html#it">it</A>:
<B> if exists('&macatsui')</B>
<B> set nomacatsui</B>
<B> endif</B>
Another option to check if you have drawing problems is
<A HREF="#'termencoding'">'termencoding'</A>.
*<A NAME="'magic'"></A><B>'magic'</B>* *<A NAME="'nomagic'"></A><B>'nomagic'</B>*
<A HREF="#'magic'">'magic'</A> <A HREF="#boolean">boolean</A> (default on)
global
Changes the special characters that can be used in search patterns.
See |<A HREF="pattern.html#pattern">pattern</A>|.
WARNING: Switching this option off most likely breaks plugins! That
is because many patterns assume it's on and will fail when it's off.
Only switch <A HREF="motion.html#it">it</A> off when working with old <A HREF="intro.html#Vi">Vi</A> scripts. In any other
situation write patterns that work when <A HREF="#'magic'">'magic'</A> is on. Include "\M"
when you want to |<A HREF="pattern.html#/\M">/\M</A>|.
*<A NAME="'makeef'"></A><B>'makeef'</B>* *<A NAME="'mef'"></A><B>'mef'</B>*
<A HREF="#'makeef'">'makeef'</A> <A HREF="#'mef'">'mef'</A> <A HREF="eval.html#string">string</A> (default: "")
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+quickfix">+quickfix</A>|
feature}
Name of the errorfile for the |<A HREF="quickfix.html#:make">:make</A>| command (see |<A HREF="quickfix.html#:make_makeprg">:make_makeprg</A>|)
and the |<A HREF="quickfix.html#:grep">:grep</A>| command.
When <A HREF="motion.html#it">it</A> is empty, an internally generated temp file will be used.
When "##" is included, <A HREF="motion.html#it">it</A> is replaced by a number to make the name
unique. This makes sure that the "<A HREF="quickfix.html#:make">:make</A>" command doesn't overwrite an
existing file.
NOT used for the "<A HREF="quickfix.html#:cf">:cf</A>" command. See <A HREF="#'errorfile'">'errorfile'</A> for that.
Environment <A HREF="eval.html#variables">variables</A> are expanded |<A HREF="#:set_env">:set_env</A>|.
See |<A HREF="#option-backslash">option-backslash</A>| about including spaces and backslashes.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'makeencoding'"></A><B>'makeencoding'</B>* *<A NAME="'menc'"></A><B>'menc'</B>*
<A HREF="#'makeencoding'">'makeencoding'</A> <A HREF="#'menc'">'menc'</A> <A HREF="eval.html#string">string</A> (default "")
global or local to buffer |<A HREF="#global-local">global-local</A>|
{only available when compiled with the |<A HREF="various.html#+multi_byte">+multi_byte</A>|
feature}
{not in Vi}
Encoding used for reading the output of external commands. When empty,
encoding is not converted.
This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
`:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
and `:laddfile`.
This would be mostly useful when you use <A HREF="os_win32.html#MS-Windows">MS-Windows</A> and set <A HREF="#'encoding'">'encoding'</A>
to "<A HREF="mbyte.html#utf-8">utf-8</A>". If |<A HREF="various.html#+iconv">+iconv</A>| is enabled and GNU libiconv is used, setting
<A HREF="#'makeencoding'">'makeencoding'</A> to "char" has the same effect <A HREF="motion.html#as">as</A> setting to the system
<A HREF="mbyte.html#locale">locale</A> encoding. Example:
<B> :set encoding=utf-8</B>
<B> :set makeencoding=char " system locale is used</B>
*<A NAME="'makeprg'"></A><B>'makeprg'</B>* *<A NAME="'mp'"></A><B>'mp'</B>*
<A HREF="#'makeprg'">'makeprg'</A> <A HREF="#'mp'">'mp'</A> <A HREF="eval.html#string">string</A> (default "make", <A HREF="os_vms.html#VMS">VMS</A>: "MMS")
global or local to buffer |<A HREF="#global-local">global-local</A>|
{not in Vi}
Program to use for the ":make" command. See |<A HREF="quickfix.html#:make_makeprg">:make_makeprg</A>|.
This option may contain '%' and '#' characters (see |<A HREF="cmdline.html#:_%">:_%</A>| and |<A HREF="cmdline.html#:_#">:_#</A>|),
which are expanded to the current and alternate file name. Use |<A HREF="cmdline.html#::S">::S</A>|
to <A HREF="intro.html#escape">escape</A> file names in <A HREF="change.html#case">case</A> they contain special characters.
Environment <A HREF="eval.html#variables">variables</A> are expanded |<A HREF="#:set_env">:set_env</A>|. See |<A HREF="#option-backslash">option-backslash</A>|
about including spaces and backslashes.
Note that a '|' must be escaped <A HREF="if_cscop.html#twice">twice</A>: once for "<A HREF="#:set">:set</A>" and once for
the interpretation of a command. When you use a <A HREF="change.html#filter">filter</A> called
"myfilter" <A HREF="diff.html#do">do</A> <A HREF="motion.html#it">it</A> like this:
<B> :set makeprg=gmake\ \\\|\ myfilter</B>
The placeholder "$*" can be given (even multiple times) to specify
where the arguments will be included, for example:
<B> :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}</B>
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'matchpairs'"></A><B>'matchpairs'</B>* *<A NAME="'mps'"></A><B>'mps'</B>*
<A HREF="#'matchpairs'">'matchpairs'</A> <A HREF="#'mps'">'mps'</A> <A HREF="eval.html#string">string</A> (default "(:),{:},[:]")
local to buffer
{not in Vi}
Characters that form pairs. The |<A HREF="motion.html#%">%</A>| command jumps from one to the
other.
Only character pairs are allowed that are different, thus you cannot
jump between two double <A HREF="quotes.html#quotes">quotes</A>.
The characters must be separated by a colon.
The pairs must be separated by a comma. Example for including '<A HREF="change.html#<"><</A>' and
'<A HREF="change.html#>">></A>' (HTML):
<B> :set mps+=<:></B>
A more exotic example, to jump between the '<A HREF="change.html#=">=</A>' and '<A HREF="motion.html#;">;</A>' in an
assignment, useful for languages like C and Java:
<B> :au FileType c,cpp,java set mps+==:;</B>
For a more advanced way of using "<A HREF="motion.html#%">%</A>", see the matchit.vim <A HREF="usr_05.html#plugin">plugin</A> in
the $VIMRUNTIME/pack/dist/opt/matchit directory. |<A HREF="usr_05.html#add-local-help">add-local-help</A>|
*<A NAME="'matchtime'"></A><B>'matchtime'</B>* *<A NAME="'mat'"></A><B>'mat'</B>*
<A HREF="#'matchtime'">'matchtime'</A> <A HREF="#'mat'">'mat'</A> number (default 5)
global
{not in Vi}{in Nvi}
Tenths of a second to show the matching paren, when <A HREF="#'showmatch'">'showmatch'</A> is
set. Note that this is not in milliseconds, like other <A HREF="#options">options</A> that
set a time. This is to be compatible with <A HREF="intro.html#Nvi">Nvi</A>.
*<A NAME="'maxcombine'"></A><B>'maxcombine'</B>* *<A NAME="'mco'"></A><B>'mco'</B>*
<A HREF="#'maxcombine'">'maxcombine'</A> <A HREF="#'mco'">'mco'</A> number (default 2)
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+multi_byte">+multi_byte</A>|
feature}
The maximum number of combining characters supported for displaying.
Only used when <A HREF="#'encoding'">'encoding'</A> is "<A HREF="mbyte.html#utf-8">utf-8</A>".
The default is OK for most languages. Hebrew may require 4.
Maximum value is 6.
Even when this option is set to 2 you can still edit text with more
combining characters, you just can't see them. Use |<A HREF="various.html#g8">g8</A>| or |<A HREF="various.html#ga">ga</A>|.
See |<A HREF="mbyte.html#mbyte-combining">mbyte-combining</A>|.
*<A NAME="'maxfuncdepth'"></A><B>'maxfuncdepth'</B>* *<A NAME="'mfd'"></A><B>'mfd'</B>*
<A HREF="#'maxfuncdepth'">'maxfuncdepth'</A> <A HREF="#'mfd'">'mfd'</A> number (default 100)
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+eval">+eval</A>|
feature}
Maximum depth of function calls for user <A HREF="eval.html#functions">functions</A>. This normally
catches endless recursion. When using a recursive function with
more depth, set <A HREF="#'maxfuncdepth'">'maxfuncdepth'</A> to a bigger number. But this will use
more memory, there is the danger of failing when memory is exhausted.
Increasing this limit above 200 also changes the maximum for <A HREF="intro.html#Ex">Ex</A>
command resursion, see |<A HREF="message.html#E169">E169</A>|.
See also |<A HREF="eval.html#:function">:function</A>|.
*<A NAME="'maxmapdepth'"></A><B>'maxmapdepth'</B>* *<A NAME="'mmd'"></A><B>'mmd'</B>* *<A NAME="E223"></A><B>E223</B>*
<A HREF="#'maxmapdepth'">'maxmapdepth'</A> <A HREF="#'mmd'">'mmd'</A> number (default 1000)
global
{not in Vi}
Maximum number of times a <A HREF="map.html#mapping">mapping</A> is done without resulting in a
character to be used. This normally catches endless mappings, like
"<A HREF="map.html#:map">:map</A> <A HREF="change.html#x">x</A> y" with "<A HREF="map.html#:map">:map</A> <A HREF="change.html#y">y</A> x". It still does not catch "<A HREF="map.html#:map">:map</A> <A HREF="index.html#g">g</A> wg",
because the '<A HREF="motion.html#w">w</A>' is used before the next <A HREF="map.html#mapping">mapping</A> is done. See also
|<A HREF="map.html#key-mapping">key-mapping</A>|.
*<A NAME="'maxmem'"></A><B>'maxmem'</B>* *<A NAME="'mm'"></A><B>'mm'</B>*
<A HREF="#'maxmem'">'maxmem'</A> <A HREF="#'mm'">'mm'</A> number (default between 256 to 5120 (system
dependent) or half the amount of memory
available)
global
{not in Vi}
Maximum amount of memory (in Kbyte) to use for one buffer. When this
limit is reached allocating extra memory for a buffer will cause
other memory to be freed. The maximum usable value is about 2000000.
Use this to work without a limit. Also see <A HREF="#'maxmemtot'">'maxmemtot'</A>.
*<A NAME="'maxmempattern'"></A><B>'maxmempattern'</B>* *<A NAME="'mmp'"></A><B>'mmp'</B>*
<A HREF="#'maxmempattern'">'maxmempattern'</A> <A HREF="#'mmp'">'mmp'</A> number (default 1000)
global
{not in Vi}
Maximum amount of memory (in Kbyte) to use for <A HREF="pattern.html#pattern">pattern</A> matching.
The maximum value is about 2000000. Use this to work without a limit.
*<A NAME="E363"></A><B>E363</B>*
When Vim runs into the limit <A HREF="motion.html#it">it</A> gives an error message and mostly
behaves like <A HREF="pattern.html#CTRL-C">CTRL-C</A> was typed.
Running into the limit often means that the <A HREF="pattern.html#pattern">pattern</A> is very
inefficient or too complex. This may already happen with the <A HREF="pattern.html#pattern">pattern</A>
"\(.\)*" on a very long line. ".*" works much better.
Vim may run out of memory before hitting the <A HREF="#'maxmempattern'">'maxmempattern'</A> limit.
*<A NAME="'maxmemtot'"></A><B>'maxmemtot'</B>* *<A NAME="'mmt'"></A><B>'mmt'</B>*
<A HREF="#'maxmemtot'">'maxmemtot'</A> <A HREF="#'mmt'">'mmt'</A> number (default between 2048 and 10240 (system
dependent) or half the amount of memory
available)
global
{not in Vi}
Maximum amount of memory in Kbyte to use for all <A HREF="windows.html#buffers">buffers</A> together.
The maximum usable value is about 2000000 (2 Gbyte). Use this to work
without a limit.
On 64 bit machines higher values might work. But hey, <A HREF="diff.html#do">do</A> you really
need more than 2 Gbyte for text editing? Keep in mind that text is
stored in the swap file, one can edit files <A HREF="change.html#>">></A> 2 Gbyte anyway. We <A HREF="diff.html#do">do</A>
need the memory to store <A HREF="undo.html#undo">undo</A> info.
Also see <A HREF="#'maxmem'">'maxmem'</A>.
*<A NAME="'menuitems'"></A><B>'menuitems'</B>* *<A NAME="'mis'"></A><B>'mis'</B>*
<A HREF="#'menuitems'">'menuitems'</A> <A HREF="#'mis'">'mis'</A> number (default 25)
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+menu">+menu</A>|
feature}
Maximum number of items to use in a menu. Used for <A HREF="gui.html#menus">menus</A> that are
generated from a <A HREF="eval.html#list">list</A> of items, e.g., the Buffers menu. Changing this
option has no direct effect, the menu must be refreshed first.
*<A NAME="'mkspellmem'"></A><B>'mkspellmem'</B>* *<A NAME="'msm'"></A><B>'msm'</B>*
<A HREF="#'mkspellmem'">'mkspellmem'</A> <A HREF="#'msm'">'msm'</A> <A HREF="eval.html#string">string</A> (default "460000,2000,500")
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+syntax">+syntax</A>|
feature}
Parameters for |<A HREF="spell.html#:mkspell">:mkspell</A>|. This tunes when to start compressing the
<A HREF="motion.html#word">word</A> tree. Compression can be slow when there are many words, but
it's needed to avoid running out of memory. The amount of memory used
per <A HREF="motion.html#word">word</A> depends very much on how similar the words are, that's why
this tuning is complicated.
There are three numbers, separated by commas:
{start},{inc},{added}
For most languages the uncompressed <A HREF="motion.html#word">word</A> tree fits in memory. {start}
gives the amount of memory in Kbyte that can be used before any
compression is done. It should be a bit smaller than the amount of
memory that is available to Vim.
When going over the {start} limit the {inc} number specifies the
amount of memory in Kbyte that can be allocated before another
compression is done. A low number means compression is done after
<A HREF="various.html#less">less</A> words are added, which is slow. A high number means more memory
will be allocated.
After doing compression, {added} times 1024 words can be added before
the {inc} limit is ignored and compression is done when any extra
amount of memory is needed. A low number means there is a smaller
chance of hitting the {inc} limit, <A HREF="various.html#less">less</A> memory is used but it's
slower.
The languages for which these numbers are important are Italian and
Hungarian. The default works for when you have about 512 Mbyte. If
you have 1 Gbyte you could use:
<B> :set mkspellmem=900000,3000,800</B>
If you have <A HREF="various.html#less">less</A> than 512 Mbyte |<A HREF="spell.html#:mkspell">:mkspell</A>| may fail for some
languages, no matter what you set <A HREF="#'mkspellmem'">'mkspellmem'</A> to.
*<A NAME="'modeline'"></A><B>'modeline'</B>* *<A NAME="'ml'"></A><B>'ml'</B>* *<A NAME="'nomodeline'"></A><B>'nomodeline'</B>* *<A NAME="'noml'"></A><B>'noml'</B>*
<A HREF="#'modeline'">'modeline'</A> <A HREF="#'ml'">'ml'</A> <A HREF="#boolean">boolean</A> (Vim default: on (off for root),
Debian: off, <A HREF="intro.html#Vi">Vi</A> default: off)
local to buffer
*<A NAME="'modelines'"></A><B>'modelines'</B>* *<A NAME="'mls'"></A><B>'mls'</B>*
<A HREF="#'modelines'">'modelines'</A> <A HREF="#'mls'">'mls'</A> number (default 5)
global
{not in Vi}
If <A HREF="#'modeline'">'modeline'</A> is on <A HREF="#'modelines'">'modelines'</A> gives the number of lines that is
checked for set commands. If <A HREF="#'modeline'">'modeline'</A> is off or <A HREF="#'modelines'">'modelines'</A> is zero
no lines are checked. See |<A HREF="#modeline">modeline</A>|.
NOTE: <A HREF="#'modeline'">'modeline'</A> is set to the <A HREF="intro.html#Vi">Vi</A> default value when <A HREF="#'compatible'">'compatible'</A> is
set and to the Vim default value when <A HREF="#'compatible'">'compatible'</A> is reset.
*<A NAME="'modifiable'"></A><B>'modifiable'</B>* *<A NAME="'ma'"></A><B>'ma'</B>* *<A NAME="'nomodifiable'"></A><B>'nomodifiable'</B>* *<A NAME="'noma'"></A><B>'noma'</B>*
<A HREF="#'modifiable'">'modifiable'</A> <A HREF="#'ma'">'ma'</A> <A HREF="#boolean">boolean</A> (default on)
local to buffer
{not in Vi} *<A NAME="E21"></A><B>E21</B>*
When off the buffer contents cannot be changed. The <A HREF="#'fileformat'">'fileformat'</A> and
<A HREF="#'fileencoding'">'fileencoding'</A> <A HREF="#options">options</A> also can't be changed.
Can be reset on <A HREF="starting.html#startup">startup</A> with the |<A HREF="starting.html#-M">-M</A>| command line argument.
*<A NAME="'modified'"></A><B>'modified'</B>* *<A NAME="'mod'"></A><B>'mod'</B>* *<A NAME="'nomodified'"></A><B>'nomodified'</B>* *<A NAME="'nomod'"></A><B>'nomod'</B>*
<A HREF="#'modified'">'modified'</A> <A HREF="#'mod'">'mod'</A> <A HREF="#boolean">boolean</A> (default off)
local to buffer
{not in Vi}
When on, the buffer is considered to be modified. This option is set
when:
1. A change was made to the text since <A HREF="motion.html#it">it</A> was last written. Using the
|<A HREF="undo.html#undo">undo</A>| command to go back to the original text will reset the
option. But undoing changes that were made before <A HREF="editing.html#writing">writing</A> the
buffer will set the option again, since the text is different from
when <A HREF="motion.html#it">it</A> was written.
2. <A HREF="#'fileformat'">'fileformat'</A> or <A HREF="#'fileencoding'">'fileencoding'</A> is different from its original
value. The original value is set when the buffer is read or
written. A "<A HREF="#:set">:set</A> <A HREF="#'nomodified'">nomodified</A>" command also resets the original
values to the current values and the <A HREF="#'modified'">'modified'</A> option will be
reset.
Similarly for <A HREF="#'eol'">'eol'</A> and <A HREF="#'bomb'">'bomb'</A>.
This option is not set when a change is made to the buffer <A HREF="motion.html#as">as</A> the
result of a <A HREF="autocmd.html#BufNewFile">BufNewFile</A>, BufRead/BufReadPost, <A HREF="autocmd.html#BufWritePost">BufWritePost</A>,
<A HREF="autocmd.html#FileAppendPost">FileAppendPost</A> or <A HREF="autocmd.html#VimLeave">VimLeave</A> <A HREF="autocmd.html#autocommand">autocommand</A> event. See |<A HREF="autocmd.html#gzip-example">gzip-example</A>| for
an explanation.
When <A HREF="#'buftype'">'buftype'</A> is "nowrite" or "nofile" this option may be set, but
will be ignored.
*<A NAME="'more'"></A><B>'more'</B>* *<A NAME="'nomore'"></A><B>'nomore'</B>*
<A HREF="#'more'">'more'</A> <A HREF="#boolean">boolean</A> (Vim default: on, <A HREF="intro.html#Vi">Vi</A> default: off)
global
{not in Vi}
When on, listings pause when the whole screen is filled. You will get
the |<A HREF="message.html#more-prompt">more-prompt</A>|. When this option is off there are no pauses, the
listing continues until finished.
NOTE: This option is set to the <A HREF="intro.html#Vi">Vi</A> default value when <A HREF="#'compatible'">'compatible'</A> is
set and to the Vim default value when <A HREF="#'compatible'">'compatible'</A> is reset.
*<A NAME="'mouse'"></A><B>'mouse'</B>* *<A NAME="E538"></A><B>E538</B>*
<A HREF="#'mouse'">'mouse'</A> <A HREF="eval.html#string">string</A> (default "", "<A HREF="insert.html#a">a</A>" for <A HREF="gui.html#GUI">GUI</A>, <A HREF="os_msdos.html#MS-DOS">MS-DOS</A> and <A HREF="os_win32.html#Win32">Win32</A>,
set to "a" in |<A HREF="defaults.html">defaults.vim</A>|)
global
{not in Vi}
Enable the use of the mouse. Only works for certain terminals
(xterm, <A HREF="os_msdos.html#MS-DOS">MS-DOS</A>, <A HREF="os_win32.html#Win32">Win32</A> |<A HREF="os_win32.html#win32-mouse">win32-mouse</A>|, <A HREF="os_qnx.html#QNX">QNX</A> pterm, *BSD console with
<A HREF="term.html#sysmouse">sysmouse</A> and Linux console with gpm). For using the mouse in the
<A HREF="gui.html#GUI">GUI</A>, see |<A HREF="gui.html#gui-mouse">gui-mouse</A>|.
The mouse can be enabled for different modes:
<A HREF="pattern.html#n">n</A> <A HREF="intro.html#Normal">Normal</A> mode and Terminal modes
<A HREF="visual.html#v">v</A> <A HREF="visual.html#Visual">Visual</A> mode
<A HREF="insert.html#i">i</A> <A HREF="insert.html#Insert">Insert</A> mode
<A HREF="change.html#c">c</A> <A HREF="cmdline.html#Command-line">Command-line</A> mode
<A HREF="motion.html#h">h</A> all previous modes when editing a help file
a all previous modes
r for |<A HREF="message.html#hit-enter">hit-enter</A>| and |<A HREF="message.html#more-prompt">more-prompt</A>| prompt
Normally you would enable the mouse in all four modes with:
<B> :set mouse=a</B>
When the mouse is not enabled, the <A HREF="gui.html#GUI">GUI</A> will still use the mouse for
modeless selection. This doesn't move the text cursor.
See |<A HREF="term.html#mouse-using">mouse-using</A>|. Also see |<A HREF="#'clipboard'">'clipboard'</A>|.
Note: When enabling the mouse in a <A HREF="terminal.html#terminal">terminal</A>, copy/paste will use the
"* <A HREF="sponsor.html#register">register</A> if there is access to an X-server. The xterm handling of
the mouse buttons can still be used by keeping the <A HREF="intro.html#shift">shift</A> key pressed.
Also see the <A HREF="#'clipboard'">'clipboard'</A> option.
*<A NAME="'mousefocus'"></A><B>'mousefocus'</B>* *<A NAME="'mousef'"></A><B>'mousef'</B>* *<A NAME="'nomousefocus'"></A><B>'nomousefocus'</B>* *<A NAME="'nomousef'"></A><B>'nomousef'</B>*
<A HREF="#'mousefocus'">'mousefocus'</A> <A HREF="#'mousef'">'mousef'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
{only works in the GUI}
The <A HREF="windows.html#window">window</A> that the mouse pointer is on is automatically activated.
When <A HREF="change.html#changing">changing</A> the <A HREF="windows.html#window">window</A> layout or <A HREF="windows.html#window">window</A> focus in another way, the
mouse pointer is moved to the <A HREF="windows.html#window">window</A> with keyboard focus. Off is the
default because <A HREF="motion.html#it">it</A> makes using the pull down <A HREF="gui.html#menus">menus</A> a little goofy, <A HREF="motion.html#as">as</A>
a pointer transit may activate a <A HREF="windows.html#window">window</A> unintentionally.
*<A NAME="'mousehide'"></A><B>'mousehide'</B>* *<A NAME="'mh'"></A><B>'mh'</B>* *<A NAME="'nomousehide'"></A><B>'nomousehide'</B>* *<A NAME="'nomh'"></A><B>'nomh'</B>*
<A HREF="#'mousehide'">'mousehide'</A> <A HREF="#'mh'">'mh'</A> <A HREF="#boolean">boolean</A> (default on)
global
{not in Vi}
{only works in the GUI}
When on, the mouse pointer is hidden when characters are typed.
The mouse pointer is restored when the mouse is moved.
*<A NAME="'mousemodel'"></A><B>'mousemodel'</B>* *<A NAME="'mousem'"></A><B>'mousem'</B>*
<A HREF="#'mousemodel'">'mousemodel'</A> <A HREF="#'mousem'">'mousem'</A> <A HREF="eval.html#string">string</A> (default "extend", "popup" for <A HREF="os_msdos.html#MS-DOS">MS-DOS</A> and <A HREF="os_win32.html#Win32">Win32</A>)
global
{not in Vi}
Sets the model to use for the mouse. The name mostly specifies what
the right mouse button is used for:
extend Right mouse button extends a selection. This works
like in an xterm.
popup Right mouse button pops up a menu. The shifted left
mouse button extends a selection. This works like
with Microsoft Windows.
popup_setpos Like "popup", but the cursor will be moved to the
position where the mouse was clicked, and thus the
selected operation will act upon the clicked object.
If clicking inside a selection, that selection will
be acted upon, i.e. no cursor move. This implies of
course, that right clicking outside a selection will
end <A HREF="visual.html#Visual">Visual</A> mode.
Overview of what button does what for each model:
<B><FONT COLOR="PURPLE"> mouse extend popup(_setpos) </FONT></B>
left click place cursor place cursor
left drag start selection start selection
shift-left search <A HREF="motion.html#word">word</A> extend selection
right click extend selection popup menu (place cursor)
right drag extend selection -
middle click paste paste
In the "popup" model the right mouse button produces a pop-up menu.
You need to define this first, see |<A HREF="gui.html#popup-menu">popup-menu</A>|.
Note that you can further refine the meaning of buttons with mappings.
See |<A HREF="gui.html#gui-mouse-mapping">gui-mouse-mapping</A>|. But mappings are NOT used for modeless
selection (because that's handled in the <A HREF="gui.html#GUI">GUI</A> code directly).
The <A HREF="#'mousemodel'">'mousemodel'</A> option is set by the |<A HREF="gui.html#:behave">:behave</A>| command.
*<A NAME="'mouseshape'"></A><B>'mouseshape'</B>* *<A NAME="'mouses'"></A><B>'mouses'</B>* *<A NAME="E547"></A><B>E547</B>*
<A HREF="#'mouseshape'">'mouseshape'</A> <A HREF="#'mouses'">'mouses'</A> <A HREF="eval.html#string">string</A> (default "i:beam,r:beam,s:updown,sd:cross,
m:no,ml:up-arrow,v:rightup-arrow")
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+mouseshape">+mouseshape</A>|
feature}
This option tells Vim what the mouse pointer should look like in
different modes. The option is a comma separated <A HREF="eval.html#list">list</A> of parts, much
like used for <A HREF="#'guicursor'">'guicursor'</A>. Each part consist of a mode/location-list
and an <A HREF="editing.html#argument-list">argument-list</A>:
mode-list:shape,mode-list:shape,..
The mode-list is a dash separated <A HREF="eval.html#list">list</A> of these modes/locations:
<B><FONT COLOR="PURPLE"> In a normal window: </FONT></B>
<A HREF="pattern.html#n">n</A> <A HREF="intro.html#Normal">Normal</A> mode
<A HREF="visual.html#v">v</A> <A HREF="visual.html#Visual">Visual</A> mode
ve <A HREF="visual.html#Visual">Visual</A> mode with <A HREF="#'selection'">'selection'</A> "<A HREF="motion.html#exclusive">exclusive</A>" (same <A HREF="motion.html#as">as</A> '<A HREF="visual.html#v">v</A>',
if not specified)
<A HREF="insert.html#o">o</A> <A HREF="intro.html#Operator-pending">Operator-pending</A> mode
<A HREF="insert.html#i">i</A> <A HREF="insert.html#Insert">Insert</A> mode
<A HREF="change.html#r">r</A> <A HREF="insert.html#Replace">Replace</A> mode
<B><FONT COLOR="PURPLE"> Others: </FONT></B>
<A HREF="change.html#c">c</A> appending to the command-line
ci <A HREF="insert.html#inserting">inserting</A> in the command-line
cr <A HREF="change.html#replacing">replacing</A> in the command-line
<A HREF="motion.html#m">m</A> at the 'Hit ENTER' or 'More' prompts
ml idem, but cursor in the last line
<A HREF="motion.html#e">e</A> any mode, pointer below last <A HREF="windows.html#window">window</A>
<A HREF="change.html#s">s</A> any mode, pointer on a status line
sd any mode, while dragging a status line
vs any mode, pointer on a vertical separator line
vd any mode, while dragging a vertical separator line
a everywhere
The shape is one of the following:
<B><FONT COLOR="PURPLE"> avail name looks like </FONT></B>
<A HREF="motion.html#w">w</A> <A HREF="change.html#x">x</A> arrow <A HREF="intro.html#Normal">Normal</A> mouse pointer
<A HREF="motion.html#w">w</A> <A HREF="change.html#x">x</A> blank no pointer at all (use with care!)
<A HREF="motion.html#w">w</A> <A HREF="change.html#x">x</A> beam I-beam
<A HREF="motion.html#w">w</A> <A HREF="change.html#x">x</A> updown up-down sizing arrows
<A HREF="motion.html#w">w</A> <A HREF="change.html#x">x</A> leftright left-right sizing arrows
<A HREF="motion.html#w">w</A> <A HREF="change.html#x">x</A> busy The system's usual busy pointer
<A HREF="motion.html#w">w</A> <A HREF="change.html#x">x</A> no The system's usual 'no input' pointer
<A HREF="change.html#x">x</A> udsizing indicates up-down resizing
<A HREF="change.html#x">x</A> lrsizing indicates left-right resizing
<A HREF="change.html#x">x</A> crosshair like a big thin +
<A HREF="change.html#x">x</A> hand1 black hand
<A HREF="change.html#x">x</A> hand2 white hand
<A HREF="change.html#x">x</A> pencil what you write with
<A HREF="change.html#x">x</A> question big ?
<A HREF="change.html#x">x</A> rightup-arrow arrow pointing right-up
<A HREF="motion.html#w">w</A> <A HREF="change.html#x">x</A> up-arrow arrow pointing up
<A HREF="change.html#x">x</A> <number> any <A HREF="#X11">X11</A> pointer number (see X11/cursorfont.h)
The "avail" column contains a '<A HREF="motion.html#w">w</A>' if the shape is available for <A HREF="os_win32.html#Win32">Win32</A>,
<A HREF="change.html#x">x</A> for <A HREF="#X11">X11</A>.
Any modes not specified or shapes not available use the normal mouse
pointer.
Example:
<B> :set mouseshape=s:udsizing,m:no</B>
will make the mouse turn to a sizing arrow over the status lines and
indicate no input when the <A HREF="message.html#hit-enter">hit-enter</A> prompt is displayed (since
clicking the mouse has no effect in this state.)
*<A NAME="'mousetime'"></A><B>'mousetime'</B>* *<A NAME="'mouset'"></A><B>'mouset'</B>*
<A HREF="#'mousetime'">'mousetime'</A> <A HREF="#'mouset'">'mouset'</A> number (default 500)
global
{not in Vi}
Only for <A HREF="gui.html#GUI">GUI</A>, <A HREF="os_msdos.html#MS-DOS">MS-DOS</A>, <A HREF="os_win32.html#Win32">Win32</A> and <A HREF="os_unix.html#Unix">Unix</A> with xterm. Defines the maximum
time in msec between two mouse clicks for the second click to be
recognized <A HREF="motion.html#as">as</A> a multi click.
*<A NAME="'mzschemedll'"></A><B>'mzschemedll'</B>*
<A HREF="#'mzschemedll'">'mzschemedll'</A> <A HREF="eval.html#string">string</A> (default depends on the build)
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+mzscheme/dyn">+mzscheme/dyn</A>|
feature}
Specifies the name of the <A HREF="if_mzsch.html#MzScheme">MzScheme</A> shared library. The default is
DYNAMIC_MZSCH_DLL which was specified at compile time.
Environment <A HREF="eval.html#variables">variables</A> are expanded |<A HREF="#:set_env">:set_env</A>|.
The value must be set in the |<A HREF="starting.html#vimrc">vimrc</A>| <A HREF="usr_41.html#script">script</A> or earlier. In the
<A HREF="starting.html#startup">startup</A>, before the |<A HREF="starting.html#load-plugins">load-plugins</A>| step.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'mzschemegcdll'"></A><B>'mzschemegcdll'</B>*
<A HREF="#'mzschemegcdll'">'mzschemegcdll'</A> <A HREF="eval.html#string">string</A> (default depends on the build)
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+mzscheme/dyn">+mzscheme/dyn</A>|
feature}
Specifies the name of the <A HREF="if_mzsch.html#MzScheme">MzScheme</A> GC shared library. The default is
DYNAMIC_MZGC_DLL which was specified at compile time.
The value can be equal to <A HREF="#'mzschemedll'">'mzschemedll'</A> if <A HREF="motion.html#it">it</A> includes the GC code.
Environment <A HREF="eval.html#variables">variables</A> are expanded |<A HREF="#:set_env">:set_env</A>|.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'mzquantum'"></A><B>'mzquantum'</B>* *<A NAME="'mzq'"></A><B>'mzq'</B>*
<A HREF="#'mzquantum'">'mzquantum'</A> <A HREF="#'mzq'">'mzq'</A> number (default 100)
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+mzscheme">+mzscheme</A>|
feature}
The number of milliseconds between polls for <A HREF="if_mzsch.html#MzScheme">MzScheme</A> threads.
Negative or zero value means no thread scheduling.
NOTE: This option is set to the Vim default value when <A HREF="#'compatible'">'compatible'</A>
is reset.
*<A NAME="'nrformats'"></A><B>'nrformats'</B>* *<A NAME="'nf'"></A><B>'nf'</B>*
<A HREF="#'nrformats'">'nrformats'</A> <A HREF="#'nf'">'nf'</A> <A HREF="eval.html#string">string</A> (default "bin,octal,hex",
set to "bin,hex" in |<A HREF="defaults.html">defaults.vim</A>|)
local to buffer
{not in Vi}
This defines what bases Vim will consider for numbers when using the
<A HREF="change.html#CTRL-A">CTRL-A</A> and <A HREF="change.html#CTRL-X">CTRL-X</A> commands for adding to and subtracting from a number
respectively; see |<A HREF="change.html#CTRL-A">CTRL-A</A>| for more info on these commands.
alpha If included, single alphabetical characters will be
incremented or decremented. This is useful for a <A HREF="eval.html#list">list</A> with a
<A HREF="print.html#letter">letter</A> index <A HREF="motion.html#a)">a)</A>, b), etc. *<A NAME="octal-nrformats"></A><B>octal-nrformats</B>*
<A HREF="eval.html#octal">octal</A> If included, numbers that start with a zero will be considered
to be <A HREF="eval.html#octal">octal</A>. Example: Using <A HREF="change.html#CTRL-A">CTRL-A</A> on "007" results in "010".
hex If included, numbers starting with "0x" or "0X" will be
considered to be hexadecimal. Example: Using <A HREF="change.html#CTRL-X">CTRL-X</A> on
"0x100" results in "0x0ff".
bin If included, numbers starting with "0b" or "0B" will be
considered to be binary. Example: Using <A HREF="change.html#CTRL-X">CTRL-X</A> on
"0b1000" subtracts one, resulting in "0b0111".
Numbers which simply begin with a digit in the range 1-9 are always
considered decimal. This also happens for numbers that are not
recognized <A HREF="motion.html#as">as</A> <A HREF="eval.html#octal">octal</A> or hex.
*<A NAME="'number'"></A><B>'number'</B>* *<A NAME="'nu'"></A><B>'nu'</B>* *<A NAME="'nonumber'"></A><B>'nonumber'</B>* *<A NAME="'nonu'"></A><B>'nonu'</B>*
<A HREF="#'number'">'number'</A> <A HREF="#'nu'">'nu'</A> <A HREF="#boolean">boolean</A> (default off)
local to <A HREF="windows.html#window">window</A>
Print the line number in front of each line. When the '<A HREF="pattern.html#n">n</A>' option is
excluded from <A HREF="#'cpoptions'">'cpoptions'</A> a wrapped line will not use the column of
line numbers (this is the default when <A HREF="#'compatible'">'compatible'</A> isn't set).
The <A HREF="#'numberwidth'">'numberwidth'</A> option can be used to set the room used for the line
number.
When a long, wrapped line doesn't start with the first character, '<A HREF="motion.html#-">-</A>'
characters are put before the number.
See |<A HREF="syntax.html#hl-LineNr">hl-LineNr</A>| and |<A HREF="syntax.html#hl-CursorLineNr">hl-CursorLineNr</A>| for the highlighting used for
the number.
*<A NAME="number_relativenumber"></A><B>number_relativenumber</B>*
The <A HREF="#'relativenumber'">'relativenumber'</A> option changes the displayed number to be
relative to the cursor. Together with <A HREF="#'number'">'number'</A> there are these
four combinations (cursor in line 3):
<A HREF="#'nonu'">'nonu'</A> <A HREF="#'nu'">'nu'</A> <A HREF="#'nonu'">'nonu'</A> <A HREF="#'nu'">'nu'</A>
<A HREF="#'nornu'">'nornu'</A> <A HREF="#'nornu'">'nornu'</A> <A HREF="#'rnu'">'rnu'</A> <A HREF="#'rnu'">'rnu'</A>
|apple | 1 apple | 2 apple | 2 apple
|pear | 2 pear | 1 pear | 1 pear
|nobody | 3 nobody | 0 nobody |3 nobody
|there | 4 there | 1 there | 1 there
*<A NAME="'numberwidth'"></A><B>'numberwidth'</B>* *<A NAME="'nuw'"></A><B>'nuw'</B>*
<A HREF="#'numberwidth'">'numberwidth'</A> <A HREF="#'nuw'">'nuw'</A> number (Vim default: 4 <A HREF="intro.html#Vi">Vi</A> default: 8)
local to <A HREF="windows.html#window">window</A>
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+linebreak">+linebreak</A>|
feature}
Minimal number of columns to use for the line number. Only relevant
when the <A HREF="#'number'">'number'</A> or <A HREF="#'relativenumber'">'relativenumber'</A> option is set or <A HREF="print.html#printing">printing</A> lines
with a line number. Since one space is always between the number and
the text, there is one <A HREF="various.html#less">less</A> character for the number itself.
The value is the minimum width. A bigger width is used when needed to
fit the highest line number in the buffer respectively the number of
rows in the <A HREF="windows.html#window">window</A>, depending on whether <A HREF="#'number'">'number'</A> or <A HREF="#'relativenumber'">'relativenumber'</A>
is set. Thus with the Vim default of 4 there is room for a line number
up to 999. When the buffer has 1000 lines five columns will be used.
The minimum value is 1, the maximum value is 10.
NOTE: This option is set to the <A HREF="intro.html#Vi">Vi</A> default value when <A HREF="#'compatible'">'compatible'</A> is
set and to the Vim default value when <A HREF="#'compatible'">'compatible'</A> is reset.
*<A NAME="'omnifunc'"></A><B>'omnifunc'</B>* *<A NAME="'ofu'"></A><B>'ofu'</B>*
<A HREF="#'omnifunc'">'omnifunc'</A> <A HREF="#'ofu'">'ofu'</A> <A HREF="eval.html#string">string</A> (default: empty)
local to buffer
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+eval">+eval</A>|
or |<A HREF="various.html#+insert_expand">+insert_expand</A>| features}
This option specifies a function to be used for <A HREF="insert.html#Insert">Insert</A> mode omni
completion with CTRL-X CTRL-O. |<A HREF="insert.html#i_CTRL-X_CTRL-O">i_CTRL-X_CTRL-O</A>|
See |<A HREF="insert.html#complete-functions">complete-functions</A>| for an explanation of how the function is
invoked and what <A HREF="motion.html#it">it</A> should return.
This option is usually set by a <A HREF="filetype.html#filetype">filetype</A> <A HREF="usr_05.html#plugin">plugin</A>:
|<A HREF="filetype.html#:filetype-plugin-on">:filetype-plugin-on</A>|
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'opendevice'"></A><B>'opendevice'</B>* *<A NAME="'odev'"></A><B>'odev'</B>* *<A NAME="'noopendevice'"></A><B>'noopendevice'</B>* *<A NAME="'noodev'"></A><B>'noodev'</B>*
<A HREF="#'opendevice'">'opendevice'</A> <A HREF="#'odev'">'odev'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
{only for <A HREF="os_msdos.html#MS-DOS">MS-DOS</A>, <A HREF="os_win32.html#MS-Windows">MS-Windows</A> and OS/2}
Enable reading and <A HREF="editing.html#writing">writing</A> from devices. This may get Vim stuck on a
device that can be opened but doesn't actually <A HREF="diff.html#do">do</A> the I/O. Therefore
<A HREF="motion.html#it">it</A> is off by default.
Note that on <A HREF="os_win32.html#MS-Windows">MS-Windows</A> editing "aux.h", "lpt1.txt" and the like also
result in editing a device.
*<A NAME="'operatorfunc'"></A><B>'operatorfunc'</B>* *<A NAME="'opfunc'"></A><B>'opfunc'</B>*
<A HREF="#'operatorfunc'">'operatorfunc'</A> <A HREF="#'opfunc'">'opfunc'</A> <A HREF="eval.html#string">string</A> (default: empty)
global
{not in Vi}
This option specifies a function to be called by the |<A HREF="map.html#g@">g@</A>| <A HREF="motion.html#operator">operator</A>.
See |<A HREF="map.html#:map-operator">:map-operator</A>| for more info and an example.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'osfiletype'"></A><B>'osfiletype'</B>* *<A NAME="'oft'"></A><B>'oft'</B>*
<A HREF="#'osfiletype'">'osfiletype'</A> <A HREF="#'oft'">'oft'</A> <A HREF="eval.html#string">string</A> (default: "")
local to buffer
{not in Vi}
This option was supported on RISC OS, which has been removed.
*<A NAME="'packpath'"></A><B>'packpath'</B>* *<A NAME="'pp'"></A><B>'pp'</B>*
<A HREF="#'packpath'">'packpath'</A> <A HREF="#'pp'">'pp'</A> <A HREF="eval.html#string">string</A> (default: see <A HREF="#'runtimepath'">'runtimepath'</A>)
{not in Vi}
Directories used to find packages. See |<A HREF="repeat.html#packages">packages</A>|.
*<A NAME="'paragraphs'"></A><B>'paragraphs'</B>* *<A NAME="'para'"></A><B>'para'</B>*
<A HREF="#'paragraphs'">'paragraphs'</A> <A HREF="#'para'">'para'</A> <A HREF="eval.html#string">string</A> (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
global
Specifies the nroff macros that separate paragraphs. These are pairs
of two letters (see |<A HREF="motion.html#object-motions">object-motions</A>|).
*<A NAME="'paste'"></A><B>'paste'</B>* *<A NAME="'nopaste'"></A><B>'nopaste'</B>*
<A HREF="#'paste'">'paste'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
Put Vim in Paste mode. This is useful if you want to cut or copy
some text from one <A HREF="windows.html#window">window</A> and paste <A HREF="motion.html#it">it</A> in Vim. This will avoid
unexpected effects.
Setting this option is useful when using Vim in a <A HREF="terminal.html#terminal">terminal</A>, where Vim
cannot distinguish between typed text and pasted text. In the <A HREF="gui.html#GUI">GUI</A>, Vim
knows about pasting and will mostly <A HREF="diff.html#do">do</A> the right thing without <A HREF="#'paste'">'paste'</A>
being set. The same is true for a <A HREF="terminal.html#terminal">terminal</A> where Vim handles the
mouse clicks itself.
This option is reset when starting the <A HREF="gui.html#GUI">GUI</A>. Thus if you set <A HREF="motion.html#it">it</A> in
your <A HREF="starting.html#.vimrc">.vimrc</A> <A HREF="motion.html#it">it</A> will work in a <A HREF="terminal.html#terminal">terminal</A>, but not in the <A HREF="gui.html#GUI">GUI</A>. Setting
<A HREF="#'paste'">'paste'</A> in the <A HREF="gui.html#GUI">GUI</A> has side effects: e.g., the Paste toolbar button
will no longer work in <A HREF="insert.html#Insert">Insert</A> mode, because <A HREF="motion.html#it">it</A> uses a <A HREF="map.html#mapping">mapping</A>.
When the <A HREF="#'paste'">'paste'</A> option is switched on (also when <A HREF="motion.html#it">it</A> was already on):
- <A HREF="map.html#mapping">mapping</A> in <A HREF="insert.html#Insert">Insert</A> mode and <A HREF="cmdline.html#Command-line">Command-line</A> mode is disabled
- <A HREF="map.html#abbreviations">abbreviations</A> are disabled
- <A HREF="#'autoindent'">'autoindent'</A> is reset
- <A HREF="#'expandtab'">'expandtab'</A> is reset
- <A HREF="#'formatoptions'">'formatoptions'</A> is used like <A HREF="motion.html#it">it</A> is empty
- <A HREF="#'revins'">'revins'</A> is reset
- <A HREF="#'ruler'">'ruler'</A> is reset
- <A HREF="#'showmatch'">'showmatch'</A> is reset
- <A HREF="#'smartindent'">'smartindent'</A> is reset
- <A HREF="#'smarttab'">'smarttab'</A> is reset
- <A HREF="#'softtabstop'">'softtabstop'</A> is set to 0
- <A HREF="#'textwidth'">'textwidth'</A> is set to 0
- <A HREF="#'wrapmargin'">'wrapmargin'</A> is set to 0
These <A HREF="#options">options</A> keep their value, but their effect is disabled:
- <A HREF="#'cindent'">'cindent'</A>
- <A HREF="#'indentexpr'">'indentexpr'</A>
- <A HREF="#'lisp'">'lisp'</A>
NOTE: When you start editing another file while the <A HREF="#'paste'">'paste'</A> option is
on, settings from the modelines or autocommands may change the
settings again, causing trouble when pasting text. You might want to
set the <A HREF="#'paste'">'paste'</A> option again.
When the <A HREF="#'paste'">'paste'</A> option is reset the mentioned <A HREF="#options">options</A> are restored to
the value before the moment <A HREF="#'paste'">'paste'</A> was switched from off to on.
Resetting <A HREF="#'paste'">'paste'</A> before ever setting <A HREF="motion.html#it">it</A> does not have any effect.
Since <A HREF="map.html#mapping">mapping</A> doesn't work while <A HREF="#'paste'">'paste'</A> is active, you need to use
the <A HREF="#'pastetoggle'">'pastetoggle'</A> option to toggle the <A HREF="#'paste'">'paste'</A> option with some key.
*<A NAME="'pastetoggle'"></A><B>'pastetoggle'</B>* *<A NAME="'pt'"></A><B>'pt'</B>*
<A HREF="#'pastetoggle'">'pastetoggle'</A> <A HREF="#'pt'">'pt'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not in Vi}
When non-empty, specifies the key sequence that toggles the <A HREF="#'paste'">'paste'</A>
option. This is like specifying a <A HREF="map.html#mapping">mapping</A>:
<B> :map {keys} :set invpaste<CR></B>
Where {keys} is the value of <A HREF="#'pastetoggle'">'pastetoggle'</A>.
The difference is that <A HREF="motion.html#it">it</A> will work even when <A HREF="#'paste'">'paste'</A> is set.
<A HREF="#'pastetoggle'">'pastetoggle'</A> works in <A HREF="insert.html#Insert">Insert</A> mode and <A HREF="intro.html#Normal">Normal</A> mode, but not in
<A HREF="cmdline.html#Command-line">Command-line</A> mode.
Mappings are checked first, thus overrule <A HREF="#'pastetoggle'">'pastetoggle'</A>. However,
when <A HREF="#'paste'">'paste'</A> is on mappings are ignored in <A HREF="insert.html#Insert">Insert</A> mode, thus you can <A HREF="diff.html#do">do</A>
this:
<B> :map <F10> :set paste<CR></B>
<B> :map <F11> :set nopaste<CR></B>
<B> :imap <F10> <C-O>:set paste<CR></B>
<B> :imap <F11> <nop></B>
<B> :set pastetoggle=<F11></B>
This will make <A HREF="term.html#<F10>"><F10></A> start paste mode and <A HREF="term.html#<F11>"><F11></A> stop paste mode.
Note that typing <A HREF="term.html#<F10>"><F10></A> in paste mode inserts "<A HREF="term.html#<F10>"><F10></A>", since in paste
mode everything is inserted literally, except the <A HREF="#'pastetoggle'">'pastetoggle'</A> key
sequence.
When the value has several bytes <A HREF="#'ttimeoutlen'">'ttimeoutlen'</A> applies.
*<A NAME="'pex'"></A><B>'pex'</B>* *<A NAME="'patchexpr'"></A><B>'patchexpr'</B>*
<A HREF="#'patchexpr'">'patchexpr'</A> <A HREF="#'pex'">'pex'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+diff">+diff</A>|
feature}
Expression which is evaluated to apply a patch to a file and generate
the resulting new version of the file. See |<A HREF="diff.html#diff-patchexpr">diff-patchexpr</A>|.
*<A NAME="'patchmode'"></A><B>'patchmode'</B>* *<A NAME="'pm'"></A><B>'pm'</B>* *<A NAME="E205"></A><B>E205</B>* *<A NAME="E206"></A><B>E206</B>*
<A HREF="#'patchmode'">'patchmode'</A> <A HREF="#'pm'">'pm'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not in Vi}
When non-empty the oldest version of a file is kept. This can be used
to keep the original version of a file if you are <A HREF="change.html#changing">changing</A> files in a
source <A HREF="intro.html#distribution">distribution</A>. Only the first time that a file is written a
copy of the original file will be kept. The name of the copy is the
name of the original file with the <A HREF="eval.html#string">string</A> in the <A HREF="#'patchmode'">'patchmode'</A> option
appended. This option should start with a dot. Use a <A HREF="eval.html#string">string</A> like
".orig" or ".org". <A HREF="#'backupdir'">'backupdir'</A> must not be empty for this to work
(Detail: The <A HREF="editing.html#backup">backup</A> file is renamed to the patchmode file after the
new file has been successfully written, that's why <A HREF="motion.html#it">it</A> must be possible
to write a <A HREF="editing.html#backup">backup</A> file). If there was no file to be backed up, an
empty file is created.
When the <A HREF="#'backupskip'">'backupskip'</A> <A HREF="pattern.html#pattern">pattern</A> matches, a patchmode file is not made.
Using <A HREF="#'patchmode'">'patchmode'</A> for compressed files appends the extension at the
end (e.g., "file.gz.orig"), thus the resulting name isn't always
recognized <A HREF="motion.html#as">as</A> a compressed file.
Only normal file name characters can be used, "/\*?[|<>" are illegal.
*<A NAME="'path'"></A><B>'path'</B>* *<A NAME="'pa'"></A><B>'pa'</B>* *<A NAME="E343"></A><B>E343</B>* *<A NAME="E345"></A><B>E345</B>* *<A NAME="E347"></A><B>E347</B>* *<A NAME="E854"></A><B>E854</B>*
<A HREF="#'path'">'path'</A> <A HREF="#'pa'">'pa'</A> <A HREF="eval.html#string">string</A> (default on <A HREF="os_unix.html#Unix">Unix</A>: ".,/usr/include,,"
on <A HREF="os_os2.html#OS/2">OS/2</A>: ".,/emx/include,,"
other systems: ".,,")
global or local to buffer |<A HREF="#global-local">global-local</A>|
{not in Vi}
This is a <A HREF="eval.html#list">list</A> of directories which will be searched when using the
|<A HREF="editing.html#gf">gf</A>|, <A HREF="editing.html#[f">[f</A>, <A HREF="editing.html#]f">]f</A>, ^Wf, |<A HREF="editing.html#:find">:find</A>|, |<A HREF="windows.html#:sfind">:sfind</A>|, |<A HREF="tabpage.html#:tabfind">:tabfind</A>| and other commands,
provided that the file being searched for has a relative path (not
starting with "<A HREF="pattern.html#/">/</A>", "./" or "../"). The directories in the <A HREF="#'path'">'path'</A>
option may be relative or absolute.
- Use commas to separate directory names:
<B> :set path=.,/usr/local/include,/usr/include</B>
- Spaces can also be used to separate directory names (for backwards
compatibility with version 3.0). To have a space in a directory
name, precede <A HREF="motion.html#it">it</A> with an extra <A HREF="intro.html#backslash">backslash</A>, and <A HREF="intro.html#escape">escape</A> the space:
<B> :set path=.,/dir/with\\\ space</B>
- To include a comma in a directory name precede <A HREF="motion.html#it">it</A> with an extra
<A HREF="intro.html#backslash">backslash</A>:
<B> :set path=.,/dir/with\\,comma</B>
- To search relative to the directory of the current file, use:
<B> :set path=.</B>
- To search in the current directory use an empty <A HREF="eval.html#string">string</A> between two
commas:
<B> :set path=,,</B>
- A directory name may end in a '<A HREF="cmdline.html#:">:</A>' or '<A HREF="pattern.html#/">/</A>'.
- Environment <A HREF="eval.html#variables">variables</A> are expanded |<A HREF="#:set_env">:set_env</A>|.
- When using |<A HREF="netrw.html">netrw.vim</A>| URLs can be used. For example, adding
"http://www.vim.org" will make ":find index.html" work.
- Search upwards and downwards in a directory tree using "*", "**" and
"<A HREF="motion.html#;">;</A>". See |<A HREF="editing.html#file-searching">file-searching</A>| for info and <A HREF="syntax.html#syntax">syntax</A>.
{not available when compiled without the |<A HREF="various.html#+path_extra">+path_extra</A>| feature}
- Careful with '\' characters, type two to get one in the option:
<B> :set path=.,c:\\include</B>
Or just use '<A HREF="pattern.html#/">/</A>' instead:
<B> :set path=.,c:/include</B>
Don't forget "<A HREF="repeat.html#.">.</A>" or files won't even be found in the same directory <A HREF="motion.html#as">as</A>
the file!
The maximum length is limited. How much depends on the system, mostly
<A HREF="motion.html#it">it</A> is something like 256 or 1024 characters.
You can check if all the include files are found, using the value of
<A HREF="#'path'">'path'</A>, see |<A HREF="tagsrch.html#:checkpath">:checkpath</A>|.
The use of |<A HREF="#:set+=">:set+=</A>| and |<A HREF="#:set-=">:set-=</A>| is preferred when adding or removing
directories from the <A HREF="eval.html#list">list</A>. This avoids problems when a future version
uses another default. To remove the current directory use:
<B> :set path-=</B>
To add the current directory use:
<B> :set path+=</B>
To use an environment variable, you probably need to replace the
separator. Here is an example to append $INCL, in which directory
names are separated with a semi-colon:
<B> :let &path = &path . "," . substitute($INCL, ';', ',', 'g')</B>
<A HREF="insert.html#Replace">Replace</A> the '<A HREF="motion.html#;">;</A>' with a '<A HREF="cmdline.html#:">:</A>' or whatever separator is used. Note that
this doesn't work when $INCL contains a comma or white space.
*<A NAME="'perldll'"></A><B>'perldll'</B>*
<A HREF="#'perldll'">'perldll'</A> <A HREF="eval.html#string">string</A> (default depends on the build)
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+perl/dyn">+perl/dyn</A>|
feature}
Specifies the name of the <A HREF="if_perl.html#Perl">Perl</A> shared library. The default is
DYNAMIC_PERL_DLL, which was specified at compile time.
Environment <A HREF="eval.html#variables">variables</A> are expanded |<A HREF="#:set_env">:set_env</A>|.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'preserveindent'"></A><B>'preserveindent'</B>* *<A NAME="'pi'"></A><B>'pi'</B>* *<A NAME="'nopreserveindent'"></A><B>'nopreserveindent'</B>* *<A NAME="'nopi'"></A><B>'nopi'</B>*
<A HREF="#'preserveindent'">'preserveindent'</A> <A HREF="#'pi'">'pi'</A> <A HREF="#boolean">boolean</A> (default off)
local to buffer
{not in Vi}
When <A HREF="change.html#changing">changing</A> the indent of the current line, preserve <A HREF="motion.html#as">as</A> much of the
indent structure <A HREF="motion.html#as">as</A> possible. Normally the indent is replaced by a
series of tabs followed by spaces <A HREF="motion.html#as">as</A> required (unless |<A HREF="#'expandtab'">'expandtab'</A>| is
enabled, in which <A HREF="change.html#case">case</A> only spaces are used). Enabling this option
means the indent will preserve <A HREF="motion.html#as">as</A> many existing characters <A HREF="motion.html#as">as</A> possible
for indenting, and only add additional tabs or spaces <A HREF="motion.html#as">as</A> required.
<A HREF="#'expandtab'">'expandtab'</A> does not apply to the preserved white space, a <A HREF="intro.html#Tab">Tab</A> remains
a <A HREF="intro.html#Tab">Tab</A>.
NOTE: When using "<A HREF="change.html#>>">>></A>" multiple times the resulting indent is a mix of
tabs and spaces. You might not like this.
NOTE: This option is reset when <A HREF="#'compatible'">'compatible'</A> is set.
Also see <A HREF="#'copyindent'">'copyindent'</A>.
Use |<A HREF="change.html#:retab">:retab</A>| to clean up white space.
*<A NAME="'previewheight'"></A><B>'previewheight'</B>* *<A NAME="'pvh'"></A><B>'pvh'</B>*
<A HREF="#'previewheight'">'previewheight'</A> <A HREF="#'pvh'">'pvh'</A> number (default 12)
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+windows">+windows</A>| or
|<A HREF="various.html#+quickfix">+quickfix</A>| features}
Default height for a preview <A HREF="windows.html#window">window</A>. Used for |<A HREF="windows.html#:ptag">:ptag</A>| and associated
commands. Used for |<A HREF="windows.html#CTRL-W_}">CTRL-W_}</A>| when no <A HREF="intro.html#count">count</A> is given.
*<A NAME="'previewwindow'"></A><B>'previewwindow'</B>* *<A NAME="'nopreviewwindow'"></A><B>'nopreviewwindow'</B>*
*<A NAME="'pvw'"></A><B>'pvw'</B>* *<A NAME="'nopvw'"></A><B>'nopvw'</B>* *<A NAME="E590"></A><B>E590</B>*
<A HREF="#'previewwindow'">'previewwindow'</A> <A HREF="#'pvw'">'pvw'</A> <A HREF="#boolean">boolean</A> (default off)
local to <A HREF="windows.html#window">window</A>
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+windows">+windows</A>| or
|<A HREF="various.html#+quickfix">+quickfix</A>| features}
Identifies the preview <A HREF="windows.html#window">window</A>. Only one <A HREF="windows.html#window">window</A> can have this option
set. It's normally not set directly, but by using one of the commands
|<A HREF="windows.html#:ptag">:ptag</A>|, |<A HREF="windows.html#:pedit">:pedit</A>|, etc.
*<A NAME="'printdevice'"></A><B>'printdevice'</B>* *<A NAME="'pdev'"></A><B>'pdev'</B>*
<A HREF="#'printdevice'">'printdevice'</A> <A HREF="#'pdev'">'pdev'</A> <A HREF="eval.html#string">string</A> (default empty)
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+printer">+printer</A>|
feature}
The name of the printer to be used for |<A HREF="print.html#:hardcopy">:hardcopy</A>|.
See |<A HREF="print.html#pdev-option">pdev-option</A>|.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'printencoding'"></A><B>'printencoding'</B>* *<A NAME="'penc'"></A><B>'penc'</B>*
<A HREF="#'printencoding'">'printencoding'</A> <A HREF="#'penc'">'penc'</A> <A HREF="eval.html#String">String</A> (default empty, except for some systems)
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+printer">+printer</A>|
and |<A HREF="various.html#+postscript">+postscript</A>| features}
Sets the character encoding used when <A HREF="print.html#printing">printing</A>.
See |<A HREF="print.html#penc-option">penc-option</A>|.
*<A NAME="'printexpr'"></A><B>'printexpr'</B>* *<A NAME="'pexpr'"></A><B>'pexpr'</B>*
<A HREF="#'printexpr'">'printexpr'</A> <A HREF="#'pexpr'">'pexpr'</A> <A HREF="eval.html#String">String</A> (default: see below)
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+printer">+printer</A>|
and |<A HREF="various.html#+postscript">+postscript</A>| features}
Expression used to print the PostScript produced with |<A HREF="print.html#:hardcopy">:hardcopy</A>|.
See |<A HREF="print.html#pexpr-option">pexpr-option</A>|.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'printfont'"></A><B>'printfont'</B>* *<A NAME="'pfn'"></A><B>'pfn'</B>*
<A HREF="#'printfont'">'printfont'</A> <A HREF="#'pfn'">'pfn'</A> <A HREF="eval.html#string">string</A> (default "courier")
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+printer">+printer</A>|
feature}
The name of the font that will be used for |<A HREF="print.html#:hardcopy">:hardcopy</A>|.
See |<A HREF="print.html#pfn-option">pfn-option</A>|.
*<A NAME="'printheader'"></A><B>'printheader'</B>* *<A NAME="'pheader'"></A><B>'pheader'</B>*
<A HREF="#'printheader'">'printheader'</A> <A HREF="#'pheader'">'pheader'</A> <A HREF="eval.html#string">string</A> (default "%<%f%h%m%=Page %N")
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+printer">+printer</A>|
feature}
The format of the header produced in |<A HREF="print.html#:hardcopy">:hardcopy</A>| output.
See |<A HREF="print.html#pheader-option">pheader-option</A>|.
*<A NAME="'printmbcharset'"></A><B>'printmbcharset'</B>* *<A NAME="'pmbcs'"></A><B>'pmbcs'</B>*
<A HREF="#'printmbcharset'">'printmbcharset'</A> <A HREF="#'pmbcs'">'pmbcs'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+printer">+printer</A>|,
|<A HREF="various.html#+postscript">+postscript</A>| and |<A HREF="various.html#+multi_byte">+multi_byte</A>| features}
The CJK character set to be used for CJK output from |<A HREF="print.html#:hardcopy">:hardcopy</A>|.
See |<A HREF="print.html#pmbcs-option">pmbcs-option</A>|.
*<A NAME="'printmbfont'"></A><B>'printmbfont'</B>* *<A NAME="'pmbfn'"></A><B>'pmbfn'</B>*
<A HREF="#'printmbfont'">'printmbfont'</A> <A HREF="#'pmbfn'">'pmbfn'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+printer">+printer</A>|,
|<A HREF="various.html#+postscript">+postscript</A>| and |<A HREF="various.html#+multi_byte">+multi_byte</A>| features}
<A HREF="eval.html#List">List</A> of font names to be used for CJK output from |<A HREF="print.html#:hardcopy">:hardcopy</A>|.
See |<A HREF="print.html#pmbfn-option">pmbfn-option</A>|.
*<A NAME="'printoptions'"></A><B>'printoptions'</B>* *<A NAME="'popt'"></A><B>'popt'</B>*
<A HREF="#'printoptions'">'printoptions'</A> <A HREF="#'popt'">'popt'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not in Vi}
{only available when compiled with |<A HREF="various.html#+printer">+printer</A>| feature}
<A HREF="eval.html#List">List</A> of items that <A HREF="intro.html#control">control</A> the format of the output of |<A HREF="print.html#:hardcopy">:hardcopy</A>|.
See |<A HREF="print.html#popt-option">popt-option</A>|.
*<A NAME="'prompt'"></A><B>'prompt'</B>* *<A NAME="'noprompt'"></A><B>'noprompt'</B>*
<A HREF="#'prompt'">'prompt'</A> <A HREF="#boolean">boolean</A> (default on)
global
When on a "<A HREF="cmdline.html#:">:</A>" prompt is used in <A HREF="intro.html#Ex">Ex</A> mode.
*<A NAME="'pumheight'"></A><B>'pumheight'</B>* *<A NAME="'ph'"></A><B>'ph'</B>*
<A HREF="#'pumheight'">'pumheight'</A> <A HREF="#'ph'">'ph'</A> number (default 0)
global
{not available when compiled without the
|<A HREF="various.html#+insert_expand">+insert_expand</A>| feature}
{not in Vi}
Determines the maximum number of items to show in the popup menu for
<A HREF="insert.html#Insert">Insert</A> mode completion. When zero <A HREF="motion.html#as">as</A> much space <A HREF="motion.html#as">as</A> available is used.
|<A HREF="insert.html#ins-completion-menu">ins-completion-menu</A>|.
*<A NAME="'pythondll'"></A><B>'pythondll'</B>*
<A HREF="#'pythondll'">'pythondll'</A> <A HREF="eval.html#string">string</A> (default depends on the build)
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+python/dyn">+python/dyn</A>|
feature}
Specifies the name of the <A HREF="if_pyth.html#Python">Python</A> 2.x shared library. The default is
DYNAMIC_PYTHON_DLL, which was specified at compile time.
Environment <A HREF="eval.html#variables">variables</A> are expanded |<A HREF="#:set_env">:set_env</A>|.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'pythonhome'"></A><B>'pythonhome'</B>*
<A HREF="#'pythonhome'">'pythonhome'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+python/dyn">+python/dyn</A>|
feature}
Specifies the name of the <A HREF="if_pyth.html#Python">Python</A> 2.x home directory. When <A HREF="#'pythonhome'">'pythonhome'</A>
and the PYTHONHOME environment variable are not set, PYTHON_HOME,
which was specified at compile time, will be used for the <A HREF="if_pyth.html#Python">Python</A> 2.x
home directory.
Environment <A HREF="eval.html#variables">variables</A> are expanded |<A HREF="#:set_env">:set_env</A>|.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'pythonthreedll'"></A><B>'pythonthreedll'</B>*
<A HREF="#'pythonthreedll'">'pythonthreedll'</A> <A HREF="eval.html#string">string</A> (default depends on the build)
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+python3/dyn">+python3/dyn</A>|
feature}
Specifies the name of the <A HREF="if_pyth.html#Python">Python</A> 3 shared library. The default is
DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Environment <A HREF="eval.html#variables">variables</A> are expanded |<A HREF="#:set_env">:set_env</A>|.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'pythonthreehome'"></A><B>'pythonthreehome'</B>*
<A HREF="#'pythonthreehome'">'pythonthreehome'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+python3/dyn">+python3/dyn</A>|
feature}
Specifies the name of the <A HREF="if_pyth.html#Python">Python</A> 3 home directory. When
<A HREF="#'pythonthreehome'">'pythonthreehome'</A> and the PYTHONHOME environment variable are not set,
PYTHON3_HOME, which was specified at compile time, will be used for
the <A HREF="if_pyth.html#Python">Python</A> 3 home directory.
Environment <A HREF="eval.html#variables">variables</A> are expanded |<A HREF="#:set_env">:set_env</A>|.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'pyxversion'"></A><B>'pyxversion'</B>* *<A NAME="'pyx'"></A><B>'pyx'</B>*
<A HREF="#'pyxversion'">'pyxversion'</A> <A HREF="#'pyx'">'pyx'</A> number (default depends on the build)
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+python">+python</A>| or
the |<A HREF="various.html#+python3">+python3</A>| feature}
Specifies the <A HREF="if_pyth.html#python">python</A> version used for pyx* <A HREF="eval.html#functions">functions</A> and commands
|<A HREF="if_pyth.html#python_x">python_x</A>|. The default value is <A HREF="motion.html#as">as</A> follows:
<B><FONT COLOR="PURPLE"> Compiled with Default </FONT></B>
|<A HREF="various.html#+python">+python</A>| and |<A HREF="various.html#+python3">+python3</A>| 0
only |<A HREF="various.html#+python">+python</A>| 2
only |<A HREF="various.html#+python3">+python3</A>| 3
Available values are 0, 2 and 3.
If <A HREF="#'pyxversion'">'pyxversion'</A> is 0, <A HREF="motion.html#it">it</A> is set to 2 or 3 after the first execution of
any python2/3 commands or <A HREF="eval.html#functions">functions</A>. E.g. `:py` sets to 2, and `:py3`
sets to 3. `:pyx` sets <A HREF="motion.html#it">it</A> to 3 if <A HREF="if_pyth.html#Python">Python</A> 3 is available, otherwise sets
to 2 if <A HREF="if_pyth.html#Python">Python</A> 2 is available.
See also: |<A HREF="if_pyth.html#has-pythonx">has-pythonx</A>|
If Vim is compiled with only |<A HREF="various.html#+python">+python</A>| or |<A HREF="various.html#+python3">+python3</A>| setting
<A HREF="#'pyxversion'">'pyxversion'</A> has no effect. The pyx* <A HREF="eval.html#functions">functions</A> and commands are
always the same <A HREF="motion.html#as">as</A> the compiled version.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'quoteescape'"></A><B>'quoteescape'</B>* *<A NAME="'qe'"></A><B>'qe'</B>*
<A HREF="#'quoteescape'">'quoteescape'</A> <A HREF="#'qe'">'qe'</A> <A HREF="eval.html#string">string</A> (default "\")
local to buffer
{not in Vi}
The characters that are used to <A HREF="intro.html#escape">escape</A> <A HREF="quotes.html#quotes">quotes</A> in a <A HREF="eval.html#string">string</A>. Used for
<A HREF="index.html#objects">objects</A> like a', a" and <A HREF="motion.html#a`">a`</A> |<A HREF="motion.html#a'">a'</A>|.
When one of the characters in this option is found inside a <A HREF="eval.html#string">string</A>,
the following character will be skipped. The default value makes the
text "foo\"bar\\" considered to be one <A HREF="eval.html#string">string</A>.
*<A NAME="'readonly'"></A><B>'readonly'</B>* *<A NAME="'ro'"></A><B>'ro'</B>* *<A NAME="'noreadonly'"></A><B>'noreadonly'</B>* *<A NAME="'noro'"></A><B>'noro'</B>*
<A HREF="#'readonly'">'readonly'</A> <A HREF="#'ro'">'ro'</A> <A HREF="#boolean">boolean</A> (default off)
local to buffer
If on, writes fail unless you use a '<A HREF="change.html#!">!</A>'. Protects you from
accidentally overwriting a file. Default on when Vim is started
in read-only mode ("vim -R") or when the executable is called "<A HREF="starting.html#view">view</A>".
When using "<A HREF="editing.html#:w!">:w!</A>" the <A HREF="#'readonly'">'readonly'</A> option is reset for the current
buffer, unless the 'Z' flag is in <A HREF="#'cpoptions'">'cpoptions'</A>.
{not in Vi:} When using the "<A HREF="editing.html#:view">:view</A>" command the <A HREF="#'readonly'">'readonly'</A> option is
set for the newly edited buffer.
See <A HREF="#'modifiable'">'modifiable'</A> for disallowing changes to the buffer.
*<A NAME="'redrawtime'"></A><B>'redrawtime'</B>* *<A NAME="'rdt'"></A><B>'rdt'</B>*
<A HREF="#'redrawtime'">'redrawtime'</A> <A HREF="#'rdt'">'rdt'</A> number (default 2000)
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+reltime">+reltime</A>|
feature}
The time in milliseconds for redrawing the display. This applies to
searching for patterns for <A HREF="#'hlsearch'">'hlsearch'</A>, |<A HREF="pattern.html#:match">:match</A>| highlighting an <A HREF="syntax.html#syntax">syntax</A>
highlighting.
When redrawing takes more than this many milliseconds no further
matches will be highlighted.
For <A HREF="syntax.html#syntax">syntax</A> highlighting the time applies per <A HREF="windows.html#window">window</A>. When over the
limit <A HREF="syntax.html#syntax">syntax</A> highlighting is disabled until |<A HREF="various.html#CTRL-L">CTRL-L</A>| is used.
This is used to avoid that Vim hangs when using a very complicated
<A HREF="pattern.html#pattern">pattern</A>.
*<A NAME="'regexpengine'"></A><B>'regexpengine'</B>* *<A NAME="'re'"></A><B>'re'</B>*
<A HREF="#'regexpengine'">'regexpengine'</A> <A HREF="#'re'">'re'</A> number (default 0)
global
{not in Vi}
This selects the default <A HREF="pattern.html#regexp">regexp</A> engine. |<A HREF="pattern.html#two-engines">two-engines</A>|
The possible values are:
0 automatic selection
1 old engine
2 <A HREF="pattern.html#NFA">NFA</A> engine
Note that when using the <A HREF="pattern.html#NFA">NFA</A> engine and the <A HREF="pattern.html#pattern">pattern</A> contains something
that is not supported the <A HREF="pattern.html#pattern">pattern</A> will not match. This is only useful
for debugging the <A HREF="pattern.html#regexp">regexp</A> engine.
Using automatic selection enables Vim to switch the engine, if the
default engine becomes too costly. E.g., when the <A HREF="pattern.html#NFA">NFA</A> engine uses too
many states. This should prevent Vim from hanging on a combination of
a complex <A HREF="pattern.html#pattern">pattern</A> with long text.
*<A NAME="'relativenumber'"></A><B>'relativenumber'</B>* *<A NAME="'rnu'"></A><B>'rnu'</B>* *<A NAME="'norelativenumber'"></A><B>'norelativenumber'</B>* *<A NAME="'nornu'"></A><B>'nornu'</B>*
<A HREF="#'relativenumber'">'relativenumber'</A> <A HREF="#'rnu'">'rnu'</A> <A HREF="#boolean">boolean</A> (default off)
local to <A HREF="windows.html#window">window</A>
{not in Vi}
Show the line number relative to the line with the cursor in front of
each line. Relative line numbers help you use the |<A HREF="intro.html#count">count</A>| you can
precede some vertical motion commands (e.g. <A HREF="motion.html#j">j</A> <A HREF="motion.html#k">k</A> + -) with, without
having to calculate <A HREF="motion.html#it">it</A> yourself. Especially useful in combination with
other commands (e.g. <A HREF="change.html#y">y</A> <A HREF="change.html#d">d</A> <A HREF="change.html#c">c</A> <A HREF="change.html#<"><</A> <A HREF="change.html#>">></A> <A HREF="change.html#gq">gq</A> <A HREF="change.html#gw">gw</A> =).
When the '<A HREF="pattern.html#n">n</A>' option is excluded from <A HREF="#'cpoptions'">'cpoptions'</A> a wrapped
line will not use the column of line numbers (this is the default when
<A HREF="#'compatible'">'compatible'</A> isn't set).
The <A HREF="#'numberwidth'">'numberwidth'</A> option can be used to set the room used for the line
number.
When a long, wrapped line doesn't start with the first character, '<A HREF="motion.html#-">-</A>'
characters are put before the number.
See |<A HREF="syntax.html#hl-LineNr">hl-LineNr</A>| and |<A HREF="syntax.html#hl-CursorLineNr">hl-CursorLineNr</A>| for the highlighting used for
the number.
The number in front of the cursor line also depends on the value of
<A HREF="#'number'">'number'</A>, see |<A HREF="#number_relativenumber">number_relativenumber</A>| for all combinations of the two
<A HREF="#options">options</A>.
*<A NAME="'remap'"></A><B>'remap'</B>* *<A NAME="'noremap'"></A><B>'noremap'</B>*
<A HREF="#'remap'">'remap'</A> <A HREF="#boolean">boolean</A> (default on)
global
Allows for mappings to work recursively. If you <A HREF="diff.html#do">do</A> not want this for
a single entry, use the :noremap[!] command.
NOTE: To avoid portability problems with Vim scripts, always keep
this option at the default "on". Only switch <A HREF="motion.html#it">it</A> off when working with
old <A HREF="intro.html#Vi">Vi</A> scripts.
*<A NAME="'renderoptions'"></A><B>'renderoptions'</B>* *<A NAME="'rop'"></A><B>'rop'</B>*
<A HREF="#'renderoptions'">'renderoptions'</A> <A HREF="#'rop'">'rop'</A> <A HREF="eval.html#string">string</A> (default: empty)
global
{not in Vi}
{only available when compiled with <A HREF="gui.html#GUI">GUI</A> and DIRECTX on
MS-Windows}
<A HREF="visual.html#Select">Select</A> a text renderer and set its <A HREF="#options">options</A>. The <A HREF="#options">options</A> depend on the
renderer.
<A HREF="autocmd.html#Syntax">Syntax</A>:
<B> set rop=type:{renderer}(,{name}:{value})*</B>
Currently, only one optional renderer is available.
<B><FONT COLOR="PURPLE"> render behavior </FONT></B>
directx Vim will draw text using DirectX (DirectWrite). It makes
drawn glyphs more beautiful than default GDI.
It requires <A HREF="#'encoding'">'encoding'</A> is "<A HREF="mbyte.html#utf-8">utf-8</A>", and only works on
<A HREF="os_win32.html#MS-Windows">MS-Windows</A> Vista or newer version.
Options:
<B><FONT COLOR="PURPLE"> name meaning type value </FONT></B>
gamma gamma float 1.0 - 2.2 (maybe)
contrast enhancedContrast float (unknown)
level clearTypeLevel float (unknown)
geom pixelGeometry int 0 - 2 (see below)
renmode renderingMode int 0 - 6 (see below)
taamode textAntialiasMode int 0 - 3 (see below)
scrlines Scroll Lines int (deprecated)
See this URL for detail (except for scrlines):
https://msdn.microsoft.com/en-us/library/dd368190.aspx
For geom: structure of a device pixel.
0 - DWRITE_PIXEL_GEOMETRY_FLAT
1 - DWRITE_PIXEL_GEOMETRY_RGB
2 - DWRITE_PIXEL_GEOMETRY_BGR
See this URL for detail:
https://msdn.microsoft.com/en-us/library/dd368114.aspx
For renmode: method of rendering glyphs.
0 - DWRITE_RENDERING_MODE_DEFAULT
1 - DWRITE_RENDERING_MODE_ALIASED
2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
3 - DWRITE_RENDERING_MODE_GDI_NATURAL
4 - DWRITE_RENDERING_MODE_NATURAL
5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6 - DWRITE_RENDERING_MODE_OUTLINE
See this URL for detail:
https://msdn.microsoft.com/en-us/library/dd368118.aspx
For taamode: antialiasing mode used for drawing text.
0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
See this URL for detail:
https://msdn.microsoft.com/en-us/library/dd368170.aspx
For scrlines:
This was used for optimizing <A HREF="scroll.html#scrolling">scrolling</A> behavior, however this
is now deprecated. If specified, <A HREF="motion.html#it">it</A> is simply ignored.
Example:
<B> set encoding=utf-8</B>
<B> set gfn=Ricty_Diminished:h12</B>
<B> set rop=type:directx</B>
If select a raster font (Courier, Terminal or FixedSys which
have ".fon" extension in file name) to <A HREF="#'guifont'">'guifont'</A>, <A HREF="motion.html#it">it</A> will be
drawn by GDI <A HREF="motion.html#as">as</A> a fallback.
NOTE: It is known that some fonts and <A HREF="#options">options</A> combination
causes trouble on drawing glyphs.
- 'renmode:5' and 'renmode:6' will not work with some
special made fonts (True-Type fonts which includes only
bitmap glyphs).
- 'taamode:3' will not work with some vector fonts.
NOTE: With this option, you can display colored emoji
(emoticon) in Windows 8.1 or later. To display colored emoji,
there are some conditions which you should notice.
- If your font includes non-colored emoji already, <A HREF="motion.html#it">it</A> will
be used.
- If your font doesn't have emoji, the system chooses an
alternative symbol font. On Windows 10, "Segoe UI Emoji"
will be used.
- When this alternative font didn't have fixed width glyph,
emoji might be rendered beyond the bounding box of drawing
cell.
Other render types are currently not supported.
*<A NAME="'report'"></A><B>'report'</B>*
<A HREF="#'report'">'report'</A> number (default 2)
global
Threshold for reporting number of lines changed. When the number of
changed lines is more than <A HREF="#'report'">'report'</A> a message will be given for most
"<A HREF="cmdline.html#:">:</A>" commands. If you want <A HREF="motion.html#it">it</A> always, set <A HREF="#'report'">'report'</A> to 0.
For the "<A HREF="change.html#:substitute">:substitute</A>" command the number of substitutions is used
instead of the number of lines.
*<A NAME="'restorescreen'"></A><B>'restorescreen'</B>* *<A NAME="'rs'"></A><B>'rs'</B>* *<A NAME="'norestorescreen'"></A><B>'norestorescreen'</B>* *<A NAME="'nors'"></A><B>'nors'</B>*
<A HREF="#'restorescreen'">'restorescreen'</A> <A HREF="#'rs'">'rs'</A> <A HREF="#boolean">boolean</A> (default on)
global
{not in Vi} {only in Windows 95/NT console version}
When set, the screen contents is restored when <A HREF="starting.html#exiting">exiting</A> Vim. This also
happens when executing external commands.
For non-Windows Vim: You can set or reset the <A HREF="term.html#'t_ti'">'t_ti'</A> and <A HREF="term.html#'t_te'">'t_te'</A>
<A HREF="#options">options</A> in your <A HREF="starting.html#.vimrc">.vimrc</A>. To disable restoring:
set t_ti= t_te=
To enable restoring (for an xterm):
set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
(Where ^[ is an <A HREF="intro.html#<Esc>"><Esc></A>, type <A HREF="visual.html#CTRL-V">CTRL-V</A> <A HREF="intro.html#<Esc>"><Esc></A> to insert <A HREF="motion.html#it">it</A>)
*<A NAME="'revins'"></A><B>'revins'</B>* *<A NAME="'ri'"></A><B>'ri'</B>* *<A NAME="'norevins'"></A><B>'norevins'</B>* *<A NAME="'nori'"></A><B>'nori'</B>*
<A HREF="#'revins'">'revins'</A> <A HREF="#'ri'">'ri'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+rightleft">+rightleft</A>|
feature}
Inserting characters in <A HREF="insert.html#Insert">Insert</A> mode will work backwards. See "typing
backwards" |<A HREF="rileft.html#ins-reverse">ins-reverse</A>|. This option can be toggled with the CTRL-_
command in <A HREF="insert.html#Insert">Insert</A> mode, when <A HREF="#'allowrevins'">'allowrevins'</A> is set.
NOTE: This option is reset when <A HREF="#'compatible'">'compatible'</A> is set.
This option is reset when <A HREF="#'paste'">'paste'</A> is set and restored when <A HREF="#'paste'">'paste'</A> is
reset.
*<A NAME="'rightleft'"></A><B>'rightleft'</B>* *<A NAME="'rl'"></A><B>'rl'</B>* *<A NAME="'norightleft'"></A><B>'norightleft'</B>* *<A NAME="'norl'"></A><B>'norl'</B>*
<A HREF="#'rightleft'">'rightleft'</A> <A HREF="#'rl'">'rl'</A> <A HREF="#boolean">boolean</A> (default off)
local to <A HREF="windows.html#window">window</A>
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+rightleft">+rightleft</A>|
feature}
When on, display orientation becomes right-to-left, i.e., characters
that are stored in the file appear from the right to the left.
Using this option, <A HREF="motion.html#it">it</A> is possible to edit files for languages that
are written from the right to the left such <A HREF="motion.html#as">as</A> Hebrew and <A HREF="arabic.html#Arabic">Arabic</A>.
This option is per <A HREF="windows.html#window">window</A>, so <A HREF="motion.html#it">it</A> is possible to edit mixed files
simultaneously, or to <A HREF="starting.html#view">view</A> the same file in both ways (this is
useful whenever you have a mixed text file with both right-to-left
and left-to-right strings so that both sets are displayed properly
in different <A HREF="windows.html#windows">windows</A>). Also see |<A HREF="rileft.html">rileft.txt</A>|.
*<A NAME="'rightleftcmd'"></A><B>'rightleftcmd'</B>* *<A NAME="'rlc'"></A><B>'rlc'</B>*
<A HREF="#'rightleftcmd'">'rightleftcmd'</A> <A HREF="#'rlc'">'rlc'</A> <A HREF="eval.html#string">string</A> (default "search")
local to <A HREF="windows.html#window">window</A>
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+rightleft">+rightleft</A>|
feature}
Each <A HREF="motion.html#word">word</A> in this option enables the command line editing to work in
right-to-left mode for a group of commands:
search "<A HREF="pattern.html#/">/</A>" and "<A HREF="pattern.html#?">?</A>" commands
This is useful for languages such <A HREF="motion.html#as">as</A> Hebrew, <A HREF="arabic.html#Arabic">Arabic</A> and <A HREF="farsi.html#Farsi">Farsi</A>.
The <A HREF="#'rightleft'">'rightleft'</A> option must be set for <A HREF="#'rightleftcmd'">'rightleftcmd'</A> to take effect.
*<A NAME="'rubydll'"></A><B>'rubydll'</B>*
<A HREF="#'rubydll'">'rubydll'</A> <A HREF="eval.html#string">string</A> (default: depends on the build)
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+ruby/dyn">+ruby/dyn</A>|
feature}
Specifies the name of the <A HREF="if_ruby.html#Ruby">Ruby</A> shared library. The default is
DYNAMIC_RUBY_DLL, which was specified at compile time.
Environment <A HREF="eval.html#variables">variables</A> are expanded |<A HREF="#:set_env">:set_env</A>|.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'ruler'"></A><B>'ruler'</B>* *<A NAME="'ru'"></A><B>'ru'</B>* *<A NAME="'noruler'"></A><B>'noruler'</B>* *<A NAME="'noru'"></A><B>'noru'</B>*
<A HREF="#'ruler'">'ruler'</A> <A HREF="#'ru'">'ru'</A> <A HREF="#boolean">boolean</A> (default off, set in |<A HREF="defaults.html">defaults.vim</A>|)
global
{not in Vi}
{not available when compiled without the
|<A HREF="various.html#+cmdline_info">+cmdline_info</A>| feature}
Show the line and column number of the cursor position, separated by a
comma. When there is room, the relative position of the displayed
text in the file is shown on the far right:
Top first line is visible
Bot last line is visible
All first and last line are visible
45% relative position in the file
If <A HREF="#'rulerformat'">'rulerformat'</A> is set, <A HREF="motion.html#it">it</A> will determine the contents of the ruler.
Each <A HREF="windows.html#window">window</A> has its own ruler. If a <A HREF="windows.html#window">window</A> has a status line, the
ruler is shown there. Otherwise <A HREF="motion.html#it">it</A> is shown in the last line of the
screen. If the statusline is given by <A HREF="#'statusline'">'statusline'</A> (i.e. not empty),
this option takes precedence over <A HREF="#'ruler'">'ruler'</A> and <A HREF="#'rulerformat'">'rulerformat'</A>
If the number of characters displayed is different from the number of
bytes in the text (e.g., for a TAB or a <A HREF="mbyte.html#multi-byte">multi-byte</A> character), both
the text column (byte number) and the screen column are shown,
separated with a dash.
For an empty line "0-1" is shown.
For an empty buffer the line number will also be zero: "0,0-1".
This option is reset when <A HREF="#'paste'">'paste'</A> is set and restored when <A HREF="#'paste'">'paste'</A> is
reset.
If you don't want to see the ruler all the time but want to know where
you are, use "g CTRL-G" |<A HREF="editing.html#g_CTRL-G">g_CTRL-G</A>|.
NOTE: This option is reset when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'rulerformat'"></A><B>'rulerformat'</B>* *<A NAME="'ruf'"></A><B>'ruf'</B>*
<A HREF="#'rulerformat'">'rulerformat'</A> <A HREF="#'ruf'">'ruf'</A> <A HREF="eval.html#string">string</A> (default empty)
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+statusline">+statusline</A>|
feature}
When this option is not empty, <A HREF="motion.html#it">it</A> determines the content of the ruler
<A HREF="eval.html#string">string</A>, <A HREF="motion.html#as">as</A> displayed for the <A HREF="#'ruler'">'ruler'</A> option.
The format of this option is like that of <A HREF="#'statusline'">'statusline'</A>.
The default ruler width is 17 characters. To make the ruler 15
characters wide, put "%15(" at the start and "%)" at the end.
Example:
<B> :set rulerformat=%15(%c%V\ %p%%%)</B>
*<A NAME="'runtimepath'"></A><B>'runtimepath'</B>* *<A NAME="'rtp'"></A><B>'rtp'</B>* *<A NAME="vimfiles"></A><B>vimfiles</B>*
<A HREF="#'runtimepath'">'runtimepath'</A> <A HREF="#'rtp'">'rtp'</A> <A HREF="eval.html#string">string</A> (default:
<A HREF="os_unix.html#Unix">Unix</A>: "$HOME/.vim,
$VIM/vimfiles,
<A HREF="starting.html#$VIMRUNTIME">$VIMRUNTIME</A>,
$VIM/vimfiles/after,
$HOME/.vim/after"
<A HREF="os_amiga.html#Amiga">Amiga</A>: "home:vimfiles,
$VIM/vimfiles,
<A HREF="starting.html#$VIMRUNTIME">$VIMRUNTIME</A>,
$VIM/vimfiles/after,
home:vimfiles/after"
PC, <A HREF="os_os2.html#OS/2">OS/2</A>: "$HOME/vimfiles,
$VIM/vimfiles,
<A HREF="starting.html#$VIMRUNTIME">$VIMRUNTIME</A>,
$VIM/vimfiles/after,
$HOME/vimfiles/after"
<A HREF="os_mac.html#Macintosh">Macintosh</A>: "$VIM:vimfiles,
<A HREF="starting.html#$VIMRUNTIME">$VIMRUNTIME</A>,
$VIM:vimfiles:after"
<A HREF="os_risc.html#RISC-OS">RISC-OS</A>: "Choices:vimfiles,
<A HREF="starting.html#$VIMRUNTIME">$VIMRUNTIME</A>,
Choices:vimfiles/after"
<A HREF="os_vms.html#VMS">VMS</A>: "sys$login:vimfiles,
$VIM/vimfiles,
<A HREF="starting.html#$VIMRUNTIME">$VIMRUNTIME</A>,
$VIM/vimfiles/after,
sys$login:vimfiles/after")
global
{not in Vi}
This is a <A HREF="eval.html#list">list</A> of directories which will be searched for runtime
files:
filetype.vim <A HREF="filetype.html#filetypes">filetypes</A> by file name |<A HREF="filetype.html#new-filetype">new-filetype</A>|
scripts.vim <A HREF="filetype.html#filetypes">filetypes</A> by file contents |<A HREF="filetype.html#new-filetype-scripts">new-filetype-scripts</A>|
autoload/ automatically loaded scripts |<A HREF="eval.html#autoload-functions">autoload-functions</A>|
colors/ color scheme files |<A HREF="syntax.html#:colorscheme">:colorscheme</A>|
compiler/ compiler files |<A HREF="quickfix.html#:compiler">:compiler</A>|
doc/ documentation |<A HREF="usr_41.html#write-local-help">write-local-help</A>|
ftplugin/ filetype plugins |<A HREF="usr_41.html#write-filetype-plugin">write-filetype-plugin</A>|
indent/ indent scripts |<A HREF="indent.html#indent-expression">indent-expression</A>|
keymap/ key <A HREF="map.html#mapping">mapping</A> files |<A HREF="mbyte.html#mbyte-keymap">mbyte-keymap</A>|
lang/ menu translations |<A HREF="mlang.html#:menutrans">:menutrans</A>|
menu.vim <A HREF="gui.html#GUI">GUI</A> <A HREF="gui.html#menus">menus</A> |<A HREF="menu.html">menu.vim</A>|
pack/ <A HREF="repeat.html#packages">packages</A> |<A HREF="repeat.html#:packadd">:packadd</A>|
plugin/ plugin scripts |<A HREF="usr_41.html#write-plugin">write-plugin</A>|
print/ files for <A HREF="print.html#printing">printing</A> |<A HREF="print.html#postscript-print-encoding">postscript-print-encoding</A>|
spell/ spell checking files |<A HREF="spell.html#spell">spell</A>|
syntax/ syntax files |<A HREF="syntax.html#mysyntaxfile">mysyntaxfile</A>|
tutor/ files for <A HREF="usr_01.html#vimtutor">vimtutor</A> |<A HREF="usr_01.html#tutor">tutor</A>|
And any other file searched for with the |<A HREF="repeat.html#:runtime">:runtime</A>| command.
The defaults for most systems are setup to search five locations:
1. In your home directory, for your personal preferences.
2. In a system-wide Vim directory, for preferences from the system
administrator.
3. In <A HREF="starting.html#$VIMRUNTIME">$VIMRUNTIME</A>, for files distributed with Vim.
*<A NAME="after-directory"></A><B>after-directory</B>*
4. In the "after" directory in the system-wide Vim directory. This is
for the system administrator to overrule or add to the distributed
defaults (rarely needed)
5. In the "after" directory in your home directory. This is for
personal preferences to overrule or add to the distributed defaults
or system-wide settings (rarely needed).
More entries are added when using |<A HREF="repeat.html#packages">packages</A>|. If <A HREF="motion.html#it">it</A> gets very long
then `:set rtp` will be truncated, use `:echo &rtp` to see the full
<A HREF="eval.html#string">string</A>.
Note that, unlike <A HREF="#'path'">'path'</A>, no <A HREF="editing.html#wildcards">wildcards</A> like "**" are allowed. <A HREF="intro.html#Normal">Normal</A>
<A HREF="editing.html#wildcards">wildcards</A> are allowed, but can significantly slow down searching for
runtime files. For speed, use <A HREF="motion.html#as">as</A> few items <A HREF="motion.html#as">as</A> possible and avoid
<A HREF="editing.html#wildcards">wildcards</A>.
See |<A HREF="repeat.html#:runtime">:runtime</A>|.
Example:
<B> :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME</B>
This will use the directory "~/vimruntime" first (containing your
personal Vim runtime files), then "/mygroup/vim" (shared between a
group of people) and finally "<A HREF="starting.html#$VIMRUNTIME">$VIMRUNTIME</A>" (the distributed runtime
files).
You probably should always include <A HREF="starting.html#$VIMRUNTIME">$VIMRUNTIME</A> somewhere, to use the
distributed runtime files. You can put a directory before <A HREF="starting.html#$VIMRUNTIME">$VIMRUNTIME</A>
to find files which replace a distributed runtime files. You can put
a directory after <A HREF="starting.html#$VIMRUNTIME">$VIMRUNTIME</A> to find files which add to distributed
runtime files.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'scroll'"></A><B>'scroll'</B>* *<A NAME="'scr'"></A><B>'scr'</B>*
<A HREF="#'scroll'">'scroll'</A> <A HREF="#'scr'">'scr'</A> number (default: half the <A HREF="windows.html#window">window</A> height)
local to <A HREF="windows.html#window">window</A>
<A HREF="eval.html#Number">Number</A> of lines to scroll with <A HREF="scroll.html#CTRL-U">CTRL-U</A> and <A HREF="scroll.html#CTRL-D">CTRL-D</A> commands. Will be
set to half the number of lines in the <A HREF="windows.html#window">window</A> when the <A HREF="windows.html#window">window</A> size
changes. If you give a <A HREF="intro.html#count">count</A> to the <A HREF="scroll.html#CTRL-U">CTRL-U</A> or <A HREF="scroll.html#CTRL-D">CTRL-D</A> command <A HREF="motion.html#it">it</A> will
be used <A HREF="motion.html#as">as</A> the new value for <A HREF="#'scroll'">'scroll'</A>. Reset to half the <A HREF="windows.html#window">window</A>
height with "<A HREF="#:set">:set</A> <A HREF="#'scroll'">scroll</A>=0". {Vi is a bit different: <A HREF="#'scroll'">'scroll'</A> gives
the number of screen lines instead of file lines, makes a difference
when lines wrap}
*<A NAME="'scrollbind'"></A><B>'scrollbind'</B>* *<A NAME="'scb'"></A><B>'scb'</B>* *<A NAME="'noscrollbind'"></A><B>'noscrollbind'</B>* *<A NAME="'noscb'"></A><B>'noscb'</B>*
<A HREF="#'scrollbind'">'scrollbind'</A> <A HREF="#'scb'">'scb'</A> <A HREF="#boolean">boolean</A> (default off)
local to <A HREF="windows.html#window">window</A>
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+scrollbind">+scrollbind</A>|
feature}
See also |<A HREF="scroll.html#scroll-binding">scroll-binding</A>|. When this option is set, the current
<A HREF="windows.html#window">window</A> scrolls <A HREF="motion.html#as">as</A> other scrollbind <A HREF="windows.html#windows">windows</A> (windows that also have
this option set) scroll. This option is useful for viewing the
differences between two versions of a file, see <A HREF="#'diff'">'diff'</A>.
See |<A HREF="#'scrollopt'">'scrollopt'</A>| for <A HREF="#options">options</A> that determine how this option should be
interpreted.
This option is mostly reset when splitting a <A HREF="windows.html#window">window</A> to edit another
file. This means that "<A HREF="windows.html#:split">:split</A> | edit file" results in two <A HREF="windows.html#windows">windows</A>
with <A HREF="scroll.html#scroll-binding">scroll-binding</A>, but "<A HREF="windows.html#:split">:split</A> file" does not.
*<A NAME="'scrolljump'"></A><B>'scrolljump'</B>* *<A NAME="'sj'"></A><B>'sj'</B>*
<A HREF="#'scrolljump'">'scrolljump'</A> <A HREF="#'sj'">'sj'</A> number (default 1)
global
{not in Vi}
Minimal number of lines to scroll when the cursor gets off the
screen (e.g., with "j"). Not used for scroll commands (e.g., <A HREF="scroll.html#CTRL-E">CTRL-E</A>,
<A HREF="scroll.html#CTRL-D">CTRL-D</A>). Useful if your <A HREF="terminal.html#terminal">terminal</A> scrolls very slowly.
When set to a negative number from -1 to -100 this is used <A HREF="motion.html#as">as</A> the
percentage of the <A HREF="windows.html#window">window</A> height. Thus -50 scrolls half the <A HREF="windows.html#window">window</A>
height.
NOTE: This option is set to 1 when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'scrolloff'"></A><B>'scrolloff'</B>* *<A NAME="'so'"></A><B>'so'</B>*
<A HREF="#'scrolloff'">'scrolloff'</A> <A HREF="#'so'">'so'</A> number (default 0, set to 5 in |<A HREF="defaults.html">defaults.vim</A>|)
global
{not in Vi}
Minimal number of screen lines to keep above and below the cursor.
This will make some context visible around where you are working. If
you set <A HREF="motion.html#it">it</A> to a very large value (999) the cursor line will always be
in the middle of the <A HREF="windows.html#window">window</A> (except at the start or end of the file or
when long lines wrap).
For <A HREF="scroll.html#scrolling">scrolling</A> horizontally see <A HREF="#'sidescrolloff'">'sidescrolloff'</A>.
NOTE: This option is set to 0 when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'scrollopt'"></A><B>'scrollopt'</B>* *<A NAME="'sbo'"></A><B>'sbo'</B>*
<A HREF="#'scrollopt'">'scrollopt'</A> <A HREF="#'sbo'">'sbo'</A> <A HREF="eval.html#string">string</A> (default "ver,jump")
global
{not available when compiled without the |<A HREF="various.html#+scrollbind">+scrollbind</A>|
feature}
{not in Vi}
This is a comma-separated <A HREF="eval.html#list">list</A> of words that specifies how
<A HREF="#'scrollbind'">'scrollbind'</A> <A HREF="windows.html#windows">windows</A> should behave. <A HREF="#'sbo'">'sbo'</A> stands for ScrollBind
Options.
The following words are available:
ver Bind vertical <A HREF="scroll.html#scrolling">scrolling</A> for <A HREF="#'scrollbind'">'scrollbind'</A> <A HREF="windows.html#windows">windows</A>
hor Bind horizontal <A HREF="scroll.html#scrolling">scrolling</A> for <A HREF="#'scrollbind'">'scrollbind'</A> <A HREF="windows.html#windows">windows</A>
jump Applies to the offset between two <A HREF="windows.html#windows">windows</A> for vertical
<A HREF="scroll.html#scrolling">scrolling</A>. This offset is the difference in the first
displayed line of the bound <A HREF="windows.html#windows">windows</A>. When moving
around in a <A HREF="windows.html#window">window</A>, another <A HREF="#'scrollbind'">'scrollbind'</A> <A HREF="windows.html#window">window</A> may
reach a position before the start or after the end of
the buffer. The offset is not changed though, when
moving back the <A HREF="#'scrollbind'">'scrollbind'</A> <A HREF="windows.html#window">window</A> will try to scroll
to the desired position when possible.
When now making that <A HREF="windows.html#window">window</A> the current one, two
things can be done with the relative offset:
1. When "jump" is not included, the relative offset is
adjusted for the scroll position in the new current
<A HREF="windows.html#window">window</A>. When going back to the other <A HREF="windows.html#window">window</A>, the
new relative offset will be used.
2. When "jump" is included, the other <A HREF="windows.html#windows">windows</A> are
scrolled to keep the same relative offset. When
going back to the other <A HREF="windows.html#window">window</A>, <A HREF="motion.html#it">it</A> still uses the
same relative offset.
Also see |<A HREF="scroll.html#scroll-binding">scroll-binding</A>|.
When <A HREF="#'diff'">'diff'</A> mode is active there always is vertical scroll binding,
even when "ver" isn't there.
*<A NAME="'sections'"></A><B>'sections'</B>* *<A NAME="'sect'"></A><B>'sect'</B>*
<A HREF="#'sections'">'sections'</A> <A HREF="#'sect'">'sect'</A> <A HREF="eval.html#string">string</A> (default "SHNHH HUnhsh")
global
Specifies the nroff macros that separate sections. These are pairs of
two letters (See |<A HREF="motion.html#object-motions">object-motions</A>|). The default makes a section start
at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
*<A NAME="'secure'"></A><B>'secure'</B>* *<A NAME="'nosecure'"></A><B>'nosecure'</B>* *<A NAME="E523"></A><B>E523</B>*
<A HREF="#'secure'">'secure'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
When on, "<A HREF="autocmd.html#:autocmd">:autocmd</A>", shell and write commands are not allowed in
"<A HREF="starting.html#.vimrc">.vimrc</A>" and "<A HREF="starting.html#.exrc">.exrc</A>" in the current directory and map commands are
displayed. Switch <A HREF="motion.html#it">it</A> off only if you know that you will not run into
problems, or when the <A HREF="#'exrc'">'exrc'</A> option is off. On <A HREF="os_unix.html#Unix">Unix</A> this option is
only used if the "<A HREF="starting.html#.vimrc">.vimrc</A>" or "<A HREF="starting.html#.exrc">.exrc</A>" is not owned by you. This can be
dangerous if the systems allows users to <A HREF="diff.html#do">do</A> a "chown". You better set
<A HREF="#'secure'">'secure'</A> at the end of your ~/.vimrc then.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'selection'"></A><B>'selection'</B>* *<A NAME="'sel'"></A><B>'sel'</B>*
<A HREF="#'selection'">'selection'</A> <A HREF="#'sel'">'sel'</A> <A HREF="eval.html#string">string</A> (default "<A HREF="motion.html#inclusive">inclusive</A>")
global
{not in Vi}
This option defines the behavior of the selection. It is only used
in <A HREF="visual.html#Visual">Visual</A> and <A HREF="visual.html#Select">Select</A> mode.
Possible values:
<B><FONT COLOR="PURPLE"> value past line inclusive </FONT></B>
old no yes
<A HREF="motion.html#inclusive">inclusive</A> yes yes
<A HREF="motion.html#exclusive">exclusive</A> yes no
"past line" means that the cursor is allowed to be positioned one
character past the line.
"<A HREF="motion.html#inclusive">inclusive</A>" means that the last character of the selection is included
in an operation. For example, when "<A HREF="change.html#x">x</A>" is used to delete the
selection.
When "old" is used and <A HREF="#'virtualedit'">'virtualedit'</A> allows the cursor to move past
the end of line the line break still isn't included.
Note that when "<A HREF="motion.html#exclusive">exclusive</A>" is used and selecting from the end
backwards, you cannot include the last character of a line, when
starting in <A HREF="intro.html#Normal">Normal</A> mode and <A HREF="#'virtualedit'">'virtualedit'</A> empty.
The <A HREF="#'selection'">'selection'</A> option is set by the |<A HREF="gui.html#:behave">:behave</A>| command.
*<A NAME="'selectmode'"></A><B>'selectmode'</B>* *<A NAME="'slm'"></A><B>'slm'</B>*
<A HREF="#'selectmode'">'selectmode'</A> <A HREF="#'slm'">'slm'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not in Vi}
This is a comma separated <A HREF="eval.html#list">list</A> of words, which specifies when to start
<A HREF="visual.html#Select">Select</A> mode instead of <A HREF="visual.html#Visual">Visual</A> mode, when a selection is started.
Possible values:
mouse when using the mouse
key when using shifted special keys
cmd when using "<A HREF="visual.html#v">v</A>", "<A HREF="visual.html#V">V</A>" or <A HREF="visual.html#CTRL-V">CTRL-V</A>
See |<A HREF="visual.html#Select-mode">Select-mode</A>|.
The <A HREF="#'selectmode'">'selectmode'</A> option is set by the |<A HREF="gui.html#:behave">:behave</A>| command.
*<A NAME="'sessionoptions'"></A><B>'sessionoptions'</B>* *<A NAME="'ssop'"></A><B>'ssop'</B>*
<A HREF="#'sessionoptions'">'sessionoptions'</A> <A HREF="#'ssop'">'ssop'</A> <A HREF="eval.html#string">string</A> (default: "blank,buffers,curdir,folds,
help,options,tabpages,winsize")
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+mksession">+mksession</A>|
feature}
Changes the effect of the |<A HREF="starting.html#:mksession">:mksession</A>| command. It is a comma
separated <A HREF="eval.html#list">list</A> of words. Each <A HREF="motion.html#word">word</A> enables saving and restoring
something:
<B><FONT COLOR="PURPLE"> word save and restore </FONT></B>
blank empty <A HREF="windows.html#windows">windows</A>
<A HREF="windows.html#buffers">buffers</A> hidden and unloaded <A HREF="windows.html#buffers">buffers</A>, not just those in <A HREF="windows.html#windows">windows</A>
curdir the current directory
<A HREF="fold.html#folds">folds</A> manually created <A HREF="fold.html#folds">folds</A>, opened/closed <A HREF="fold.html#folds">folds</A> and local
fold <A HREF="#options">options</A>
globals global <A HREF="eval.html#variables">variables</A> that start with an <A HREF="change.html#uppercase">uppercase</A> <A HREF="print.html#letter">letter</A>
and contain at least one <A HREF="change.html#lowercase">lowercase</A> <A HREF="print.html#letter">letter</A>. Only
<A HREF="eval.html#String">String</A> and <A HREF="eval.html#Number">Number</A> types are stored.
help the help <A HREF="windows.html#window">window</A>
localoptions <A HREF="#options">options</A> and mappings local to a <A HREF="windows.html#window">window</A> or buffer (not
global values for local <A HREF="#options">options</A>)
<A HREF="#options">options</A> all <A HREF="#options">options</A> and mappings (also global values for local
<A HREF="#options">options</A>)
resize size of the Vim <A HREF="windows.html#window">window</A>: <A HREF="#'lines'">'lines'</A> and <A HREF="#'columns'">'columns'</A>
sesdir the directory in which the session file is located
will become the current directory (useful with
projects accessed over a <A HREF="pi_netrw.html#network">network</A> from different
systems)
slash backslashes in file names replaced with forward
slashes
tabpages all <A HREF="intro.html#tab">tab</A> pages; without this only the current <A HREF="intro.html#tab">tab</A> page
is restored, so that you can make a session for each
<A HREF="intro.html#tab">tab</A> page separately
<A HREF="os_unix.html#unix">unix</A> with <A HREF="os_unix.html#Unix">Unix</A> end-of-line format (single <NL>), even when
on Windows or <A HREF="os_dos.html#DOS">DOS</A>
winpos position of the whole Vim <A HREF="windows.html#window">window</A>
winsize <A HREF="windows.html#window">window</A> sizes
Don't include both "curdir" and "sesdir".
When neither "curdir" nor "sesdir" is included, file names are stored
with absolute paths.
"slash" and "<A HREF="os_unix.html#unix">unix</A>" are useful on Windows when sharing session files
with <A HREF="os_unix.html#Unix">Unix</A>. The <A HREF="os_unix.html#Unix">Unix</A> version of Vim cannot source <A HREF="os_dos.html#dos">dos</A> format scripts,
but the Windows version of Vim can source <A HREF="os_unix.html#unix">unix</A> format scripts.
*<A NAME="'shell'"></A><B>'shell'</B>* *<A NAME="'sh'"></A><B>'sh'</B>* *<A NAME="E91"></A><B>E91</B>*
<A HREF="#'shell'">'shell'</A> <A HREF="#'sh'">'sh'</A> <A HREF="eval.html#string">string</A> (default $SHELL or "sh",
<A HREF="os_msdos.html#MS-DOS">MS-DOS</A> and <A HREF="os_win32.html#Win32">Win32</A>: "command.com" or
"cmd.exe", <A HREF="os_os2.html#OS/2">OS/2</A>: "cmd")
global
Name of the shell to use for ! and <A HREF="various.html#:!">:!</A> commands. When <A HREF="change.html#changing">changing</A> the
value also check these <A HREF="#options">options</A>: <A HREF="#'shelltype'">'shelltype'</A>, <A HREF="#'shellpipe'">'shellpipe'</A>, <A HREF="#'shellslash'">'shellslash'</A>
<A HREF="#'shellredir'">'shellredir'</A>, <A HREF="#'shellquote'">'shellquote'</A>, <A HREF="#'shellxquote'">'shellxquote'</A> and <A HREF="#'shellcmdflag'">'shellcmdflag'</A>.
It is allowed to give an argument to the command, e.g. "csh -f".
See |<A HREF="#option-backslash">option-backslash</A>| about including spaces and backslashes.
Environment <A HREF="eval.html#variables">variables</A> are expanded |<A HREF="#:set_env">:set_env</A>|.
If the name of the shell contains a space, you might need to enclose
<A HREF="motion.html#it">it</A> in <A HREF="quotes.html#quotes">quotes</A>. Example:
<B> :set shell=\"c:\program\ files\unix\sh.exe\"\ -f</B>
Note the <A HREF="intro.html#backslash">backslash</A> before each <A HREF="change.html#quote">quote</A> (to avoid starting a comment) and
each space (to avoid ending the option value). Also note that the
"<A HREF="starting.html#-f">-f</A>" is not inside the <A HREF="quotes.html#quotes">quotes</A>, because <A HREF="motion.html#it">it</A> is not part of the command
name. And Vim automagically recognizes the backslashes that are path
separators.
Under <A HREF="os_win32.html#MS-Windows">MS-Windows</A>, when the executable ends in ".com" <A HREF="motion.html#it">it</A> must be
included. Thus setting the shell to "command.com" or "4dos.com"
works, but "command" and "4dos" <A HREF="diff.html#do">do</A> not work for all commands (e.g.,
filtering).
For unknown reasons, when using "4dos.com" the current directory is
changed to "C:\". To avoid this set <A HREF="#'shell'">'shell'</A> like this:
<B> :set shell=command.com\ /c\ 4dos</B>
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'shellcmdflag'"></A><B>'shellcmdflag'</B>* *<A NAME="'shcf'"></A><B>'shcf'</B>*
<A HREF="#'shellcmdflag'">'shellcmdflag'</A> <A HREF="#'shcf'">'shcf'</A> <A HREF="eval.html#string">string</A> (default: "<A HREF="starting.html#-c">-c</A>";
<A HREF="os_msdos.html#MS-DOS">MS-DOS</A> and <A HREF="os_win32.html#Win32">Win32</A>, when <A HREF="#'shell'">'shell'</A> does not
contain "sh" somewhere: "/c")
global
{not in Vi}
Flag passed to the shell to execute "<A HREF="change.html#!">!</A>" and "<A HREF="various.html#:!">:!</A>" commands; e.g.,
"bash.exe <A HREF="starting.html#-c">-c</A> ls" or "command.com /c dir". For the MS-DOS-like
systems, the default is set according to the value of <A HREF="#'shell'">'shell'</A>, to
reduce the need to set this option by the user.
On <A HREF="os_unix.html#Unix">Unix</A> <A HREF="motion.html#it">it</A> can have more than one flag. Each white space separated
part is passed <A HREF="motion.html#as">as</A> an argument to the shell command.
See |<A HREF="#option-backslash">option-backslash</A>| about including spaces and backslashes.
Also see |<A HREF="os_dos.html#dos-shell">dos-shell</A>| for <A HREF="os_msdos.html#MS-DOS">MS-DOS</A> and <A HREF="os_win32.html#MS-Windows">MS-Windows</A>.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'shellpipe'"></A><B>'shellpipe'</B>* *<A NAME="'sp'"></A><B>'sp'</B>*
'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")|||
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+quickfix">+quickfix</A>|
feature}
<A HREF="eval.html#String">String</A> to be used to put the output of the "<A HREF="quickfix.html#:make">:make</A>" command in the
error file. See also |<A HREF="quickfix.html#:make_makeprg">:make_makeprg</A>|. See |<A HREF="#option-backslash">option-backslash</A>| about
including spaces and backslashes.
The name of the temporary file can be represented by "%s" if necessary
(the file name is appended automatically if no %s appears in the value
of this option).
For the <A HREF="os_amiga.html#Amiga">Amiga</A> and <A HREF="os_msdos.html#MS-DOS">MS-DOS</A> the default is "<A HREF="change.html#>">></A>". The output is directly
saved in a file and not echoed to the screen.
For <A HREF="os_unix.html#Unix">Unix</A> the default <A HREF="motion.html#it">it</A> "| tee". The stdout of the compiler is saved
in a file and echoed to the screen. If the <A HREF="#'shell'">'shell'</A> option is "csh" or
"tcsh" after initializations, the default becomes "|& tee". If the
<A HREF="#'shell'">'shell'</A> option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
default becomes "2>&1| tee". This means that stderr is also included.
Before using the <A HREF="#'shell'">'shell'</A> option a path is removed, thus "/bin/sh" uses
"sh".
The <A HREF="starting.html#initialization">initialization</A> of this option is done after reading the "<A HREF="starting.html#.vimrc">.vimrc</A>"
and the other initializations, so that when the <A HREF="#'shell'">'shell'</A> option is set
there, the <A HREF="#'shellpipe'">'shellpipe'</A> option changes automatically, unless <A HREF="motion.html#it">it</A> was
explicitly set before.
When <A HREF="#'shellpipe'">'shellpipe'</A> is set to an empty <A HREF="eval.html#string">string</A>, no redirection of the
"<A HREF="quickfix.html#:make">:make</A>" output will be done. This is useful if you use a <A HREF="#'makeprg'">'makeprg'</A>
that writes to <A HREF="#'makeef'">'makeef'</A> by itself. If you want no piping, but <A HREF="diff.html#do">do</A>
want to include the <A HREF="#'makeef'">'makeef'</A>, set <A HREF="#'shellpipe'">'shellpipe'</A> to a single space.
Don't forget to precede the space with a <A HREF="intro.html#backslash">backslash</A>: "<A HREF="#:set">:set</A> <A HREF="#'sp'">sp</A>=\ ".
In the future pipes may be used for filtering and this option will
become obsolete (at least for <A HREF="os_unix.html#Unix">Unix</A>).
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'shellquote'"></A><B>'shellquote'</B>* *<A NAME="'shq'"></A><B>'shq'</B>*
<A HREF="#'shellquote'">'shellquote'</A> <A HREF="#'shq'">'shq'</A> <A HREF="eval.html#string">string</A> (default: ""; <A HREF="os_msdos.html#MS-DOS">MS-DOS</A> and <A HREF="os_win32.html#Win32">Win32</A>, when <A HREF="#'shell'">'shell'</A>
contains "sh" somewhere: "\"")
global
{not in Vi}
Quoting character(s), put around the command passed to the shell, for
the "<A HREF="change.html#!">!</A>" and "<A HREF="various.html#:!">:!</A>" commands. The redirection is kept outside of the
quoting. See <A HREF="#'shellxquote'">'shellxquote'</A> to include the redirection. It's
probably not useful to set both <A HREF="#options">options</A>.
This is an empty <A HREF="eval.html#string">string</A> by default. Only known to be useful for
third-party shells on MS-DOS-like systems, such <A HREF="motion.html#as">as</A> the MKS Korn Shell
or bash, where <A HREF="motion.html#it">it</A> should be "\"". The default is adjusted according
the value of <A HREF="#'shell'">'shell'</A>, to reduce the need to set this option by the
user. See |<A HREF="os_dos.html#dos-shell">dos-shell</A>|.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'shellredir'"></A><B>'shellredir'</B>* *<A NAME="'srr'"></A><B>'srr'</B>*
<A HREF="#'shellredir'">'shellredir'</A> <A HREF="#'srr'">'srr'</A> <A HREF="eval.html#string">string</A> (default "<A HREF="change.html#>">></A>", ">&" or ">%s 2>&1")
global
{not in Vi}
<A HREF="eval.html#String">String</A> to be used to put the output of a <A HREF="change.html#filter">filter</A> command in a temporary
file. See also |<A HREF="various.html#:!">:!</A>|. See |<A HREF="#option-backslash">option-backslash</A>| about including spaces
and backslashes.
The name of the temporary file can be represented by "%s" if necessary
(the file name is appended automatically if no %s appears in the value
of this option).
The default is "<A HREF="change.html#>">></A>". For <A HREF="os_unix.html#Unix">Unix</A>, if the <A HREF="#'shell'">'shell'</A> option is "csh", "tcsh"
or "zsh" during initializations, the default becomes ">&". If the
<A HREF="#'shell'">'shell'</A> option is "sh", "ksh" or "bash" the default becomes
">%s 2>&1". This means that stderr is also included.
For <A HREF="os_win32.html#Win32">Win32</A>, the <A HREF="os_unix.html#Unix">Unix</A> checks are done and additionally "cmd" is checked
for, which makes the default ">%s 2>&1". Also, the same names with
".exe" appended are checked for.
The <A HREF="starting.html#initialization">initialization</A> of this option is done after reading the "<A HREF="starting.html#.vimrc">.vimrc</A>"
and the other initializations, so that when the <A HREF="#'shell'">'shell'</A> option is set
there, the <A HREF="#'shellredir'">'shellredir'</A> option changes automatically unless <A HREF="motion.html#it">it</A> was
explicitly set before.
In the future pipes may be used for filtering and this option will
become obsolete (at least for <A HREF="os_unix.html#Unix">Unix</A>).
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'shellslash'"></A><B>'shellslash'</B>* *<A NAME="'ssl'"></A><B>'ssl'</B>* *<A NAME="'noshellslash'"></A><B>'noshellslash'</B>* *<A NAME="'nossl'"></A><B>'nossl'</B>*
<A HREF="#'shellslash'">'shellslash'</A> <A HREF="#'ssl'">'ssl'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi} {only for <A HREF="os_msdos.html#MSDOS">MSDOS</A>, <A HREF="os_win32.html#MS-Windows">MS-Windows</A> and OS/2}
When set, a forward slash is used when expanding file names. This is
useful when a Unix-like shell is used instead of command.com or
cmd.exe. Backward slashes can still be typed, but they are changed to
forward slashes by Vim.
Note that setting or resetting this option has no effect for some
existing file names, thus this option needs to be set before opening
any file for best results. This might change in the future.
<A HREF="#'shellslash'">'shellslash'</A> only works when a <A HREF="intro.html#backslash">backslash</A> can be used <A HREF="motion.html#as">as</A> a path
separator. To test if this is so use:
<B> if exists('+shellslash')</B>
*<A NAME="'shelltemp'"></A><B>'shelltemp'</B>* *<A NAME="'stmp'"></A><B>'stmp'</B>* *<A NAME="'noshelltemp'"></A><B>'noshelltemp'</B>* *<A NAME="'nostmp'"></A><B>'nostmp'</B>*
<A HREF="#'shelltemp'">'shelltemp'</A> <A HREF="#'stmp'">'stmp'</A> <A HREF="#boolean">boolean</A> (Vi default off, Vim default on)
global
{not in Vi}
When on, use temp files for shell commands. When off use a pipe.
When using a pipe is not possible temp files are used anyway.
Currently a pipe is only supported on <A HREF="os_unix.html#Unix">Unix</A> and <A HREF="os_win32.html#MS-Windows">MS-Windows</A> 2K and
later. You can check <A HREF="motion.html#it">it</A> with:
<B> :if has("filterpipe")</B>
The advantage of using a pipe is that nobody can read the temp file
and the <A HREF="#'shell'">'shell'</A> command does not need to support redirection.
The advantage of using a temp file is that the file type and encoding
can be detected.
The |<A HREF="autocmd.html#FilterReadPre">FilterReadPre</A>|, |<A HREF="autocmd.html#FilterReadPost">FilterReadPost</A>| and |<A HREF="autocmd.html#FilterWritePre">FilterWritePre</A>|,
|<A HREF="autocmd.html#FilterWritePost">FilterWritePost</A>| autocommands event are not triggered when
<A HREF="#'shelltemp'">'shelltemp'</A> is off.
The `system()` function does not respect this option and always uses
temp files.
NOTE: This option is set to the Vim default value when <A HREF="#'compatible'">'compatible'</A>
is reset.
*<A NAME="'shelltype'"></A><B>'shelltype'</B>* *<A NAME="'st'"></A><B>'st'</B>*
<A HREF="#'shelltype'">'shelltype'</A> <A HREF="#'st'">'st'</A> number (default 0)
global
{not in Vi} {only for the Amiga}
On the <A HREF="os_amiga.html#Amiga">Amiga</A> this option influences the way how the commands work
which use a shell.
0 and 1: always use the shell
2 and 3: use the shell only to <A HREF="change.html#filter">filter</A> lines
4 and 5: use shell only for '<A HREF="various.html#:sh">:sh</A>' command
When not using the shell, the command is executed directly.
0 and 2: use "shell <A HREF="#'shellcmdflag'">'shellcmdflag'</A> cmd" to start external commands
1 and 3: use "shell cmd" to start external commands
*<A NAME="'shellxescape'"></A><B>'shellxescape'</B>* *<A NAME="'sxe'"></A><B>'sxe'</B>*
<A HREF="#'shellxescape'">'shellxescape'</A> <A HREF="#'sxe'">'sxe'</A> <A HREF="eval.html#string">string</A> (default: "";
for <A HREF="os_msdos.html#MS-DOS">MS-DOS</A> and <A HREF="os_win32.html#MS-Windows">MS-Windows</A>: "\"&|<>()@^")
global
{not in Vi}
When <A HREF="#'shellxquote'">'shellxquote'</A> is set to "<A HREF="motion.html#(">(</A>" then the characters listed in this
option will be escaped with a '<A HREF="motion.html#^">^</A>' character. This makes <A HREF="motion.html#it">it</A> possible
to execute most external commands with cmd.exe.
*<A NAME="'shellxquote'"></A><B>'shellxquote'</B>* *<A NAME="'sxq'"></A><B>'sxq'</B>*
<A HREF="#'shellxquote'">'shellxquote'</A> <A HREF="#'sxq'">'sxq'</A> <A HREF="eval.html#string">string</A> (default: "";
for <A HREF="os_win32.html#Win32">Win32</A>, when <A HREF="#'shell'">'shell'</A> is cmd.exe: "<A HREF="motion.html#(">(</A>"
for <A HREF="os_win32.html#Win32">Win32</A>, when <A HREF="#'shell'">'shell'</A> contains "sh"
somewhere: "\""
for <A HREF="os_unix.html#Unix">Unix</A>, when using <A HREF="eval.html#system()">system()</A>: "\"")
global
{not in Vi}
Quoting character(s), put around the command passed to the shell, for
the "<A HREF="change.html#!">!</A>" and "<A HREF="various.html#:!">:!</A>" commands. Includes the redirection. See
<A HREF="#'shellquote'">'shellquote'</A> to exclude the redirection. It's probably not useful
to set both <A HREF="#options">options</A>.
When the value is '<A HREF="motion.html#(">(</A>' then '<A HREF="motion.html#)">)</A>' is appended. When the value is '"'('
then ')"' is appended.
When the value is '<A HREF="motion.html#(">(</A>' then also see <A HREF="#'shellxescape'">'shellxescape'</A>.
This is an empty <A HREF="eval.html#string">string</A> by default on most systems, but is known to be
useful for on <A HREF="os_win32.html#Win32">Win32</A> version, either for cmd.exe which automatically
strips off the first and last <A HREF="change.html#quote">quote</A> on a command, or 3rd-party shells
such <A HREF="motion.html#as">as</A> the MKS Korn Shell or bash, where <A HREF="motion.html#it">it</A> should be "\"". The
default is adjusted according the value of <A HREF="#'shell'">'shell'</A>, to reduce the need
to set this option by the user. See |<A HREF="os_dos.html#dos-shell">dos-shell</A>|.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'shiftround'"></A><B>'shiftround'</B>* *<A NAME="'sr'"></A><B>'sr'</B>* *<A NAME="'noshiftround'"></A><B>'noshiftround'</B>* *<A NAME="'nosr'"></A><B>'nosr'</B>*
<A HREF="#'shiftround'">'shiftround'</A> <A HREF="#'sr'">'sr'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
Round indent to multiple of <A HREF="#'shiftwidth'">'shiftwidth'</A>. Applies to <A HREF="change.html#>">></A> and <A HREF="change.html#<"><</A>
commands. <A HREF="tagsrch.html#CTRL-T">CTRL-T</A> and <A HREF="scroll.html#CTRL-D">CTRL-D</A> in <A HREF="insert.html#Insert">Insert</A> mode always round the indent to
a multiple of <A HREF="#'shiftwidth'">'shiftwidth'</A> (this is <A HREF="intro.html#Vi">Vi</A> compatible).
NOTE: This option is reset when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'shiftwidth'"></A><B>'shiftwidth'</B>* *<A NAME="'sw'"></A><B>'sw'</B>*
<A HREF="#'shiftwidth'">'shiftwidth'</A> <A HREF="#'sw'">'sw'</A> number (default 8)
local to buffer
<A HREF="eval.html#Number">Number</A> of spaces to use for each step of (auto)indent. Used for
|<A HREF="#'cindent'">'cindent'</A>|, |<A HREF="change.html#>>">>></A>|, |<A HREF="change.html#<<"><<</A>|, etc.
When zero the <A HREF="#'ts'">'ts'</A> value will be used. Use the |<A HREF="eval.html#shiftwidth()">shiftwidth()</A>|
function to get the effective shiftwidth value.
*<A NAME="'shortmess'"></A><B>'shortmess'</B>* *<A NAME="'shm'"></A><B>'shm'</B>*
<A HREF="#'shortmess'">'shortmess'</A> <A HREF="#'shm'">'shm'</A> <A HREF="eval.html#string">string</A> (Vim default "filnxtToO", <A HREF="intro.html#Vi">Vi</A> default: "",
POSIX default: "<A HREF="insert.html#A">A</A>")
global
{not in Vi}
This option helps to avoid all the |<A HREF="message.html#hit-enter">hit-enter</A>| prompts caused by file
<A HREF="message.html#messages">messages</A>, for example with <A HREF="editing.html#CTRL-G">CTRL-G</A>, and to avoid some other <A HREF="message.html#messages">messages</A>.
It is a <A HREF="eval.html#list">list</A> of flags:
<B><FONT COLOR="PURPLE"> flag meaning when present </FONT></B>
<A HREF="motion.html#f">f</A> use "(3 of 5)" instead of "(file 3 of 5)"
<A HREF="insert.html#i">i</A> use "[noeol]" instead of "[Incomplete last line]"
<A HREF="motion.html#l">l</A> use "999L, 888C" instead of "999 lines, 888 characters"
<A HREF="motion.html#m">m</A> use "[+]" instead of "[Modified]"
<A HREF="pattern.html#n">n</A> use "[New]" instead of "[New File]"
<A HREF="change.html#r">r</A> use "[RO]" instead of "[readonly]"
<A HREF="motion.html#w">w</A> use "[w]" instead of "written" for file write message
and "[a]" instead of "appended" for ':w <A HREF="change.html#>>">>></A> file' command
<A HREF="change.html#x">x</A> use "[dos]" instead of "[dos format]", "[unix]" instead of
"[unix format]" and "[mac]" instead of "[mac format]".
a all of the above <A HREF="map.html#abbreviations">abbreviations</A>
<A HREF="insert.html#o">o</A> overwrite message for <A HREF="editing.html#writing">writing</A> a file with subsequent message
for reading a file (useful for "<A HREF="editing.html#:wn">:wn</A>" or when <A HREF="#'autowrite'">'autowrite'</A> on)
<A HREF="insert.html#O">O</A> message for reading a file overwrites any previous message.
Also for <A HREF="quickfix.html#quickfix">quickfix</A> message (e.g., ":cn").
<A HREF="change.html#s">s</A> don't give "search hit BOTTOM, continuing at TOP" or "search
hit TOP, continuing at BOTTOM" <A HREF="message.html#messages">messages</A>
t truncate file message at the start if <A HREF="motion.html#it">it</A> is too long to fit
on the command-line, "<A HREF="change.html#<"><</A>" will appear in the left most column.
Ignored in <A HREF="intro.html#Ex">Ex</A> mode.
<A HREF="motion.html#T">T</A> truncate other <A HREF="message.html#messages">messages</A> in the middle if they are too long to
fit on the command line. "<A HREF="eval.html#...">...</A>" will appear in the middle.
Ignored in <A HREF="intro.html#Ex">Ex</A> mode.
<A HREF="motion.html#W">W</A> don't give "written" or "[w]" when <A HREF="editing.html#writing">writing</A> a file
A don't give the "<A HREF="usr_11.html#ATTENTION">ATTENTION</A>" message when an existing swap file
is found.
I don't give the intro message when starting Vim |<A HREF="starting.html#:intro">:intro</A>|.
c don't give |<A HREF="insert.html#ins-completion-menu">ins-completion-menu</A>| <A HREF="message.html#messages">messages</A>. For example,
"<A HREF="starting.html#--">--</A> XXX completion (YYY)", "match 1 of 2", "The only match",
"<A HREF="pattern.html#Pattern">Pattern</A> not found", "Back at original", etc.
<A HREF="repeat.html#q">q</A> use "<A HREF="repeat.html#recording">recording</A>" instead of "<A HREF="repeat.html#recording">recording</A> @a"
<A HREF="motion.html#F">F</A> don't give the file info when editing a file, like `:silent`
was used for the command
This gives you the opportunity to avoid that a change between <A HREF="windows.html#buffers">buffers</A>
requires you to hit <A HREF="intro.html#<Enter>"><Enter></A>, but still gives <A HREF="motion.html#as">as</A> useful a message <A HREF="motion.html#as">as</A>
possible for the space available. To get the whole message that you
would have got with <A HREF="#'shm'">'shm'</A> empty, use ":file!"
Useful values:
shm= No abbreviation of message.
shm=a Abbreviation, but no loss of information.
shm=at Abbreviation, and truncate message when necessary.
NOTE: This option is set to the <A HREF="intro.html#Vi">Vi</A> default value when <A HREF="#'compatible'">'compatible'</A> is
set and to the Vim default value when <A HREF="#'compatible'">'compatible'</A> is reset.
*<A NAME="'shortname'"></A><B>'shortname'</B>* *<A NAME="'sn'"></A><B>'sn'</B>* *<A NAME="'noshortname'"></A><B>'noshortname'</B>* *<A NAME="'nosn'"></A><B>'nosn'</B>*
<A HREF="#'shortname'">'shortname'</A> <A HREF="#'sn'">'sn'</A> <A HREF="#boolean">boolean</A> (default off)
local to buffer
{not in <A HREF="intro.html#Vi">Vi</A>, not in <A HREF="os_msdos.html#MS-DOS">MS-DOS</A> versions}
Filenames are assumed to be 8 characters plus one extension of 3
characters. Multiple dots in file names are not allowed. When this
option is on, dots in file names are replaced with underscores when
adding an extension (".~" or ".swp"). This option is not available
for <A HREF="os_msdos.html#MS-DOS">MS-DOS</A>, because then <A HREF="motion.html#it">it</A> would always be on. This option is useful
when editing files on an <A HREF="os_msdos.html#MS-DOS">MS-DOS</A> compatible filesystem, e.g., messydos
or crossdos. When running the <A HREF="os_win32.html#Win32">Win32</A> <A HREF="gui.html#GUI">GUI</A> version under Win32s, this
option is always on by default.
*<A NAME="'showbreak'"></A><B>'showbreak'</B>* *<A NAME="'sbr'"></A><B>'sbr'</B>* *<A NAME="E595"></A><B>E595</B>*
<A HREF="#'showbreak'">'showbreak'</A> <A HREF="#'sbr'">'sbr'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+linebreak">+linebreak</A>|
feature}
<A HREF="eval.html#String">String</A> to put at the start of lines that have been wrapped. Useful
values are "<A HREF="change.html#>">></A> " or "+++ ":
<B> :set showbreak=>\ </B>
Note the <A HREF="intro.html#backslash">backslash</A> to <A HREF="intro.html#escape">escape</A> the trailing space. It's easier like
this:
<B> :let &showbreak = '+++ '</B>
Only printable single-cell characters are allowed, excluding <A HREF="motion.html#<Tab>"><Tab></A> and
comma (in a future version the comma might be used to separate the
part that is shown at the end and at the start of a line).
The characters are highlighted according to the '<A HREF="repeat.html#@">@</A>' flag in
<A HREF="#'highlight'">'highlight'</A>.
Note that tabs after the showbreak will be displayed differently.
If you want the <A HREF="#'showbreak'">'showbreak'</A> to appear in between line numbers, add the
"<A HREF="pattern.html#n">n</A>" flag to <A HREF="#'cpoptions'">'cpoptions'</A>.
*<A NAME="'showcmd'"></A><B>'showcmd'</B>* *<A NAME="'sc'"></A><B>'sc'</B>* *<A NAME="'noshowcmd'"></A><B>'noshowcmd'</B>* *<A NAME="'nosc'"></A><B>'nosc'</B>*
<A HREF="#'showcmd'">'showcmd'</A> <A HREF="#'sc'">'sc'</A> <A HREF="#boolean">boolean</A> (Vim default: on, off for <A HREF="os_unix.html#Unix">Unix</A>,
<A HREF="intro.html#Vi">Vi</A> default: off, set in |<A HREF="defaults.html">defaults.vim</A>|)
global
{not in Vi}
{not available when compiled without the
|<A HREF="various.html#+cmdline_info">+cmdline_info</A>| feature}
Show (partial) command in the last line of the screen. Set this
option off if your <A HREF="terminal.html#terminal">terminal</A> is slow.
In <A HREF="visual.html#Visual">Visual</A> mode the size of the selected area is shown:
- When selecting characters within a line, the number of characters.
If the number of bytes is different <A HREF="motion.html#it">it</A> is also displayed: "2-6"
means two characters and six bytes.
- When selecting more than one line, the number of lines.
- When selecting a block, the size in screen characters:
{lines}x{columns}.
NOTE: This option is set to the <A HREF="intro.html#Vi">Vi</A> default value when <A HREF="#'compatible'">'compatible'</A> is
set and to the Vim default value when <A HREF="#'compatible'">'compatible'</A> is reset.
*<A NAME="'showfulltag'"></A><B>'showfulltag'</B>* *<A NAME="'sft'"></A><B>'sft'</B>* *<A NAME="'noshowfulltag'"></A><B>'noshowfulltag'</B>* *<A NAME="'nosft'"></A><B>'nosft'</B>*
<A HREF="#'showfulltag'">'showfulltag'</A> <A HREF="#'sft'">'sft'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
When completing a <A HREF="motion.html#word">word</A> in insert mode (see |<A HREF="insert.html#ins-completion">ins-completion</A>|) from the
<A HREF="tagsrch.html#tags">tags</A> file, show both the <A HREF="tagsrch.html#tag">tag</A> name and a tidied-up form of the search
<A HREF="pattern.html#pattern">pattern</A> (if there is one) <A HREF="motion.html#as">as</A> possible matches. Thus, if you have
matched a C function, you can see a <A HREF="autocmd.html#template">template</A> for what arguments are
required (coding style permitting).
Note that this doesn't work well together with having "longest" in
<A HREF="#'completeopt'">'completeopt'</A>, because the completion from the search <A HREF="pattern.html#pattern">pattern</A> may not
match the typed text.
*<A NAME="'showmatch'"></A><B>'showmatch'</B>* *<A NAME="'sm'"></A><B>'sm'</B>* *<A NAME="'noshowmatch'"></A><B>'noshowmatch'</B>* *<A NAME="'nosm'"></A><B>'nosm'</B>*
<A HREF="#'showmatch'">'showmatch'</A> <A HREF="#'sm'">'sm'</A> <A HREF="#boolean">boolean</A> (default off)
global
When a bracket is inserted, briefly jump to the matching one. The
jump is only done if the match can be seen on the screen. The time to
show the match can be set with <A HREF="#'matchtime'">'matchtime'</A>.
A Beep is given if there is no match (no matter if the match can be
seen or not).
This option is reset when <A HREF="#'paste'">'paste'</A> is set and restored when <A HREF="#'paste'">'paste'</A> is
reset.
When the '<A HREF="motion.html#m">m</A>' flag is not included in <A HREF="#'cpoptions'">'cpoptions'</A>, typing a character
will immediately move the cursor back to where <A HREF="motion.html#it">it</A> belongs.
See the "sm" field in <A HREF="#'guicursor'">'guicursor'</A> for setting the cursor shape and
blinking when showing the match.
The <A HREF="#'matchpairs'">'matchpairs'</A> option can be used to specify the characters to show
matches for. <A HREF="#'rightleft'">'rightleft'</A> and <A HREF="#'revins'">'revins'</A> are used to look for opposite
matches.
Also see the <A HREF="pi_paren.html#matchparen">matchparen</A> <A HREF="usr_05.html#plugin">plugin</A> for highlighting the match when moving
around |<A HREF="pi_paren.html">pi_paren.txt</A>|.
Note: Use of the short form is rated PG.
*<A NAME="'showmode'"></A><B>'showmode'</B>* *<A NAME="'smd'"></A><B>'smd'</B>* *<A NAME="'noshowmode'"></A><B>'noshowmode'</B>* *<A NAME="'nosmd'"></A><B>'nosmd'</B>*
<A HREF="#'showmode'">'showmode'</A> <A HREF="#'smd'">'smd'</A> <A HREF="#boolean">boolean</A> (Vim default: on, <A HREF="intro.html#Vi">Vi</A> default: off)
global
If in <A HREF="insert.html#Insert">Insert</A>, <A HREF="insert.html#Replace">Replace</A> or <A HREF="visual.html#Visual">Visual</A> mode put a message on the last line.
Use the '<A HREF="motion.html#M">M</A>' flag in <A HREF="#'highlight'">'highlight'</A> to set the type of highlighting for
this message.
When |<A HREF="mbyte.html#XIM">XIM</A>| may be used the message will include "XIM". But this
doesn't mean <A HREF="mbyte.html#XIM">XIM</A> is really active, especially when <A HREF="#'imactivatekey'">'imactivatekey'</A> is
not set.
NOTE: This option is set to the <A HREF="intro.html#Vi">Vi</A> default value when <A HREF="#'compatible'">'compatible'</A> is
set and to the Vim default value when <A HREF="#'compatible'">'compatible'</A> is reset.
*<A NAME="'showtabline'"></A><B>'showtabline'</B>* *<A NAME="'stal'"></A><B>'stal'</B>*
<A HREF="#'showtabline'">'showtabline'</A> <A HREF="#'stal'">'stal'</A> number (default 1)
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+windows">+windows</A>|
feature}
The value of this option specifies when the line with <A HREF="intro.html#tab">tab</A> page labels
will be displayed:
0: never
1: only if there are at least two <A HREF="intro.html#tab">tab</A> pages
2: always
This is both for the <A HREF="gui.html#GUI">GUI</A> and non-GUI implementation of the <A HREF="intro.html#tab">tab</A> pages
line.
See |<A HREF="tabpage.html#tab-page">tab-page</A>| for more information about tab pages.
*<A NAME="'sidescroll'"></A><B>'sidescroll'</B>* *<A NAME="'ss'"></A><B>'ss'</B>*
<A HREF="#'sidescroll'">'sidescroll'</A> <A HREF="#'ss'">'ss'</A> number (default 0)
global
{not in Vi}
The minimal number of columns to scroll horizontally. Used only when
the <A HREF="#'wrap'">'wrap'</A> option is off and the cursor is moved off of the screen.
When <A HREF="motion.html#it">it</A> is zero the cursor will be put in the middle of the screen.
When using a slow <A HREF="terminal.html#terminal">terminal</A> set <A HREF="motion.html#it">it</A> to a large number or 0. When using
a fast <A HREF="terminal.html#terminal">terminal</A> use a small number or 1. Not used for "<A HREF="scroll.html#zh">zh</A>" and "<A HREF="scroll.html#zl">zl</A>"
commands.
*<A NAME="'sidescrolloff'"></A><B>'sidescrolloff'</B>* *<A NAME="'siso'"></A><B>'siso'</B>*
<A HREF="#'sidescrolloff'">'sidescrolloff'</A> <A HREF="#'siso'">'siso'</A> number (default 0)
global
{not in Vi}
The minimal number of screen columns to keep to the left and to the
right of the cursor if <A HREF="#'nowrap'">'nowrap'</A> is set. Setting this option to a
value greater than 0 while having |<A HREF="#'sidescroll'">'sidescroll'</A>| also at a non-zero
value makes some context visible in the line you are <A HREF="scroll.html#scrolling">scrolling</A> in
horizontally (except at beginning of the line). Setting this option
to a large value (like 999) has the effect of keeping the cursor
horizontally centered in the <A HREF="windows.html#window">window</A>, <A HREF="motion.html#as">as</A> long <A HREF="motion.html#as">as</A> one does not come too
close to the beginning of the line.
NOTE: This option is set to 0 when <A HREF="#'compatible'">'compatible'</A> is set.
Example: Try this together with <A HREF="#'sidescroll'">'sidescroll'</A> and <A HREF="#'listchars'">'listchars'</A> <A HREF="motion.html#as">as</A>
in the following example to never allow the cursor to move
onto the "extends" character:
<B> :set nowrap sidescroll=1 listchars=extends:>,precedes:<</B>
<B> :set sidescrolloff=1</B>
*<A NAME="'signcolumn'"></A><B>'signcolumn'</B>* *<A NAME="'scl'"></A><B>'scl'</B>*
<A HREF="#'signcolumn'">'signcolumn'</A> <A HREF="#'scl'">'scl'</A> <A HREF="eval.html#string">string</A> (default "auto")
local to <A HREF="windows.html#window">window</A>
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+signs">+signs</A>|
feature}
Whether or not to draw the signcolumn. Valid values are:
"auto" only when there is a sign to display
"no" never
"yes" always
*<A NAME="'smartcase'"></A><B>'smartcase'</B>* *<A NAME="'scs'"></A><B>'scs'</B>* *<A NAME="'nosmartcase'"></A><B>'nosmartcase'</B>* *<A NAME="'noscs'"></A><B>'noscs'</B>*
<A HREF="#'smartcase'">'smartcase'</A> <A HREF="#'scs'">'scs'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
Override the <A HREF="#'ignorecase'">'ignorecase'</A> option if the search <A HREF="pattern.html#pattern">pattern</A> contains upper
<A HREF="change.html#case">case</A> characters. Only used when the search <A HREF="pattern.html#pattern">pattern</A> is typed and
<A HREF="#'ignorecase'">'ignorecase'</A> option is on. Used for the commands "<A HREF="pattern.html#/">/</A>", "<A HREF="pattern.html#?">?</A>", "<A HREF="pattern.html#n">n</A>", "<A HREF="pattern.html#N">N</A>",
"<A HREF="repeat.html#:g">:g</A>" and "<A HREF="change.html#:s">:s</A>". Not used for "*", "<A HREF="pattern.html##">#</A>", "<A HREF="pattern.html#gd">gd</A>", <A HREF="tagsrch.html#tag">tag</A> search, etc. After
"*" and "<A HREF="pattern.html##">#</A>" you can make <A HREF="#'smartcase'">'smartcase'</A> used by doing a "<A HREF="pattern.html#/">/</A>" command,
recalling the search <A HREF="pattern.html#pattern">pattern</A> from <A HREF="cmdline.html#history">history</A> and hitting <A HREF="intro.html#<Enter>"><Enter></A>.
NOTE: This option is reset when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'smartindent'"></A><B>'smartindent'</B>* *<A NAME="'si'"></A><B>'si'</B>* *<A NAME="'nosmartindent'"></A><B>'nosmartindent'</B>* *<A NAME="'nosi'"></A><B>'nosi'</B>*
<A HREF="#'smartindent'">'smartindent'</A> <A HREF="#'si'">'si'</A> <A HREF="#boolean">boolean</A> (default off)
local to buffer
{not in Vi}
{not available when compiled without the
|<A HREF="various.html#+smartindent">+smartindent</A>| feature}
Do smart autoindenting when starting a new line. Works for C-like
programs, but can also be used for other languages. <A HREF="#'cindent'">'cindent'</A> does
something like this, works better in most cases, but is more strict,
see |<A HREF="indent.html#C-indenting">C-indenting</A>|. When <A HREF="#'cindent'">'cindent'</A> is on or <A HREF="#'indentexpr'">'indentexpr'</A> is set,
setting <A HREF="#'si'">'si'</A> has no effect. <A HREF="#'indentexpr'">'indentexpr'</A> is a more advanced
alternative.
Normally <A HREF="#'autoindent'">'autoindent'</A> should also be on when using <A HREF="#'smartindent'">'smartindent'</A>.
An indent is automatically inserted:
- After a line ending in '<A HREF="motion.html#{">{</A>'.
- After a line starting with a keyword from <A HREF="#'cinwords'">'cinwords'</A>.
- Before a line starting with '<A HREF="motion.html#}">}</A>' (only with the "<A HREF="insert.html#O">O</A>" command).
When typing '<A HREF="motion.html#}">}</A>' <A HREF="motion.html#as">as</A> the first character in a new line, that line is
given the same indent <A HREF="motion.html#as">as</A> the matching '<A HREF="motion.html#{">{</A>'.
When typing '<A HREF="pattern.html##">#</A>' <A HREF="motion.html#as">as</A> the first character in a new line, the indent for
that line is removed, the '<A HREF="pattern.html##">#</A>' is put in the first column. The indent
is restored for the next line. If you don't want this, use this
<A HREF="map.html#mapping">mapping</A>: "<A HREF="map.html#:inoremap">:inoremap</A> # X^H#", where ^H is entered with <A HREF="visual.html#CTRL-V">CTRL-V</A> <A HREF="motion.html#CTRL-H">CTRL-H</A>.
When using the "<A HREF="change.html#>>">>></A>" command, lines starting with '<A HREF="pattern.html##">#</A>' are not shifted
right.
NOTE: This option is reset when <A HREF="#'compatible'">'compatible'</A> is set.
This option is reset when <A HREF="#'paste'">'paste'</A> is set and restored when <A HREF="#'paste'">'paste'</A> is
reset.
*<A NAME="'smarttab'"></A><B>'smarttab'</B>* *<A NAME="'sta'"></A><B>'sta'</B>* *<A NAME="'nosmarttab'"></A><B>'nosmarttab'</B>* *<A NAME="'nosta'"></A><B>'nosta'</B>*
<A HREF="#'smarttab'">'smarttab'</A> <A HREF="#'sta'">'sta'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
When on, a <A HREF="motion.html#<Tab>"><Tab></A> in front of a line inserts blanks according to
<A HREF="#'shiftwidth'">'shiftwidth'</A>. <A HREF="#'tabstop'">'tabstop'</A> or <A HREF="#'softtabstop'">'softtabstop'</A> is used in other places. A
<A HREF="motion.html#<BS>"><BS></A> will delete a <A HREF="#'shiftwidth'">'shiftwidth'</A> worth of space at the start of the
line.
When off, a <A HREF="motion.html#<Tab>"><Tab></A> always inserts blanks according to <A HREF="#'tabstop'">'tabstop'</A> or
<A HREF="#'softtabstop'">'softtabstop'</A>. <A HREF="#'shiftwidth'">'shiftwidth'</A> is only used for shifting text left or
right |<A HREF="change.html#shift-left-right">shift-left-right</A>|.
What gets inserted (a <A HREF="motion.html#<Tab>"><Tab></A> or spaces) depends on the <A HREF="#'expandtab'">'expandtab'</A>
option. Also see |<A HREF="insert.html#ins-expandtab">ins-expandtab</A>|. When <A HREF="#'expandtab'">'expandtab'</A> is not set, the
number of spaces is minimized by using <Tab>s.
This option is reset when <A HREF="#'paste'">'paste'</A> is set and restored when <A HREF="#'paste'">'paste'</A> is
reset.
NOTE: This option is reset when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'softtabstop'"></A><B>'softtabstop'</B>* *<A NAME="'sts'"></A><B>'sts'</B>*
<A HREF="#'softtabstop'">'softtabstop'</A> <A HREF="#'sts'">'sts'</A> number (default 0)
local to buffer
{not in Vi}
<A HREF="eval.html#Number">Number</A> of spaces that a <A HREF="motion.html#<Tab>"><Tab></A> counts for while performing editing
operations, like <A HREF="insert.html#inserting">inserting</A> a <A HREF="motion.html#<Tab>"><Tab></A> or using <A HREF="motion.html#<BS>"><BS></A>. It "feels" like
<Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
used. This is useful to keep the <A HREF="#'ts'">'ts'</A> setting at its standard value
of 8, while being able to edit like <A HREF="motion.html#it">it</A> is set to <A HREF="#'sts'">'sts'</A>. However,
commands like "<A HREF="change.html#x">x</A>" still work on the actual characters.
When <A HREF="#'sts'">'sts'</A> is zero, this feature is off.
When <A HREF="#'sts'">'sts'</A> is negative, the value of <A HREF="#'shiftwidth'">'shiftwidth'</A> is used.
<A HREF="#'softtabstop'">'softtabstop'</A> is set to 0 when the <A HREF="#'paste'">'paste'</A> option is set and restored
when <A HREF="#'paste'">'paste'</A> is reset.
See also |<A HREF="insert.html#ins-expandtab">ins-expandtab</A>|. When <A HREF="#'expandtab'">'expandtab'</A> is not set, the number of
spaces is minimized by using <Tab>s.
The '<A HREF="motion.html#L">L</A>' flag in <A HREF="#'cpoptions'">'cpoptions'</A> changes how tabs are used when <A HREF="#'list'">'list'</A> is
set.
NOTE: This option is set to 0 when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'spell'"></A><B>'spell'</B>* *<A NAME="'nospell'"></A><B>'nospell'</B>*
<A HREF="#'spell'">'spell'</A> <A HREF="#boolean">boolean</A> (default off)
local to <A HREF="windows.html#window">window</A>
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+syntax">+syntax</A>|
feature}
When on spell checking will be done. See |<A HREF="spell.html#spell">spell</A>|.
The languages are specified with <A HREF="#'spelllang'">'spelllang'</A>.
*<A NAME="'spellcapcheck'"></A><B>'spellcapcheck'</B>* *<A NAME="'spc'"></A><B>'spc'</B>*
<A HREF="#'spellcapcheck'">'spellcapcheck'</A> <A HREF="#'spc'">'spc'</A> <A HREF="eval.html#string">string</A> (default "[.?!]\_[\])'"' \t]\+")
local to buffer
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+syntax">+syntax</A>|
feature}
<A HREF="pattern.html#Pattern">Pattern</A> to locate the end of a <A HREF="motion.html#sentence">sentence</A>. The following <A HREF="motion.html#word">word</A> will be
checked to start with a capital <A HREF="print.html#letter">letter</A>. If not then <A HREF="motion.html#it">it</A> is highlighted
with SpellCap |<A HREF="syntax.html#hl-SpellCap">hl-SpellCap</A>| (unless the <A HREF="motion.html#word">word</A> is also badly spelled).
When this check is not wanted make this option empty.
Only used when <A HREF="#'spell'">'spell'</A> is set.
Be careful with special characters, see |<A HREF="#option-backslash">option-backslash</A>| about
including spaces and backslashes.
To set this option automatically depending on the language, see
|<A HREF="spell.html#set-spc-auto">set-spc-auto</A>|.
*<A NAME="'spellfile'"></A><B>'spellfile'</B>* *<A NAME="'spf'"></A><B>'spf'</B>*
<A HREF="#'spellfile'">'spellfile'</A> <A HREF="#'spf'">'spf'</A> <A HREF="eval.html#string">string</A> (default empty)
local to buffer
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+syntax">+syntax</A>|
feature}
Name of the <A HREF="motion.html#word">word</A> <A HREF="eval.html#list">list</A> file where words are added for the |<A HREF="spell.html#zg">zg</A>| and |<A HREF="spell.html#zw">zw</A>|
commands. It must end in ".{encoding}.add". You need to include the
path, otherwise the file is placed in the current directory.
*<A NAME="E765"></A><B>E765</B>*
It may also be a comma separated <A HREF="eval.html#list">list</A> of names. A <A HREF="intro.html#count">count</A> before the
|<A HREF="spell.html#zg">zg</A>| and |<A HREF="spell.html#zw">zw</A>| commands can be used to access each. This allows using
a personal <A HREF="motion.html#word">word</A> <A HREF="eval.html#list">list</A> file and a project <A HREF="motion.html#word">word</A> <A HREF="eval.html#list">list</A> file.
When a <A HREF="motion.html#word">word</A> is added while this option is empty Vim will set <A HREF="motion.html#it">it</A> for
you: Using the first directory in <A HREF="#'runtimepath'">'runtimepath'</A> that is writable. If
there is no "<A HREF="spell.html#spell">spell</A>" directory yet <A HREF="motion.html#it">it</A> will be created. For the file
name the first language name that appears in <A HREF="#'spelllang'">'spelllang'</A> is used,
ignoring the region.
The resulting ".spl" file will be used for <A HREF="spell.html#spell">spell</A> checking, <A HREF="motion.html#it">it</A> does not
have to appear in <A HREF="#'spelllang'">'spelllang'</A>.
Normally one file is used for all regions, but you can add the region
name if you want to. However, <A HREF="motion.html#it">it</A> will then only be used when
<A HREF="#'spellfile'">'spellfile'</A> is set to <A HREF="motion.html#it">it</A>, for entries in <A HREF="#'spelllang'">'spelllang'</A> only files
without region name will be found.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'spelllang'"></A><B>'spelllang'</B>* *<A NAME="'spl'"></A><B>'spl'</B>*
<A HREF="#'spelllang'">'spelllang'</A> <A HREF="#'spl'">'spl'</A> <A HREF="eval.html#string">string</A> (default "en")
local to buffer
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+syntax">+syntax</A>|
feature}
A comma separated <A HREF="eval.html#list">list</A> of <A HREF="motion.html#word">word</A> <A HREF="eval.html#list">list</A> names. When the <A HREF="#'spell'">'spell'</A> option is
on spellchecking will be done for these languages. Example:
<B> set spelllang=en_us,nl,medical</B>
This means US English, Dutch and medical words are recognized. Words
that are not recognized will be highlighted.
The <A HREF="motion.html#word">word</A> <A HREF="eval.html#list">list</A> name must not include a comma or dot. Using a dash is
recommended to separate the two <A HREF="print.html#letter">letter</A> language name from a
specification. Thus "en-rare" is used for rare English words.
A region name must come last and have the form "_xx", where "xx" is
the two-letter, lower <A HREF="change.html#case">case</A> region name. You can use more than one
region by listing them: "en_us,en_ca" supports both US and Canadian
English, but not words specific for Australia, New Zealand or Great
Britain. (Note: currently en_au and en_nz dictionaries are older than
en_ca, en_gb and en_us).
If the name "cjk" is included East Asian characters are excluded from
<A HREF="spell.html#spell">spell</A> checking. This is useful when editing text that also has Asian
words.
*<A NAME="E757"></A><B>E757</B>*
As a special <A HREF="change.html#case">case</A> the name of a .spl file can be given as-is. The
first "_xx" in the name is removed and used <A HREF="motion.html#as">as</A> the region name
(_xx is an underscore, two letters and followed by a non-letter).
This is mainly for <A HREF="eval.html#testing">testing</A> purposes. You must make sure the correct
encoding is used, Vim doesn't check <A HREF="motion.html#it">it</A>.
When <A HREF="#'encoding'">'encoding'</A> is set the <A HREF="motion.html#word">word</A> lists are reloaded. Thus it's a good
idea to set <A HREF="#'spelllang'">'spelllang'</A> after setting <A HREF="#'encoding'">'encoding'</A> to avoid loading the
files <A HREF="if_cscop.html#twice">twice</A>.
How the related spell files are found is explained here: |<A HREF="spell.html#spell-load">spell-load</A>|.
If the |<A HREF="spellfile.html">spellfile.vim</A>| <A HREF="usr_05.html#plugin">plugin</A> is active and you use a language name
for which Vim cannot find the .spl file in <A HREF="#'runtimepath'">'runtimepath'</A> the <A HREF="usr_05.html#plugin">plugin</A>
will ask you if you want to <A HREF="intro.html#download">download</A> the file.
After this option has been set successfully, Vim will source the files
"spell/LANG.vim" in <A HREF="#'runtimepath'">'runtimepath'</A>. "LANG" is the value of <A HREF="#'spelllang'">'spelllang'</A>
up to the first comma, dot or underscore.
Also see |<A HREF="spell.html#set-spc-auto">set-spc-auto</A>|.
*<A NAME="'spellsuggest'"></A><B>'spellsuggest'</B>* *<A NAME="'sps'"></A><B>'sps'</B>*
<A HREF="#'spellsuggest'">'spellsuggest'</A> <A HREF="#'sps'">'sps'</A> <A HREF="eval.html#string">string</A> (default "best")
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+syntax">+syntax</A>|
feature}
Methods used for spelling suggestions. Both for the |<A HREF="spell.html#z=">z=</A>| command and
the |<A HREF="eval.html#spellsuggest()">spellsuggest()</A>| function. This is a comma-separated <A HREF="eval.html#list">list</A> of
items:
best Internal method that works best for English. Finds
changes like "fast" and uses a bit of sound-a-like
scoring to improve the ordering.
double Internal method that uses two methods and mixes the
results. The first method is "fast", the other method
computes how much the suggestion sounds like the bad
<A HREF="motion.html#word">word</A>. That only works when the language specifies
sound <A HREF="fold.html#folding">folding</A>. Can be slow and doesn't always give
better results.
fast Internal method that only checks for simple changes:
character inserts/deletes/swaps. Works well for
simple typing mistakes.
{number} The maximum number of suggestions listed for |<A HREF="spell.html#z=">z=</A>|.
Not used for |<A HREF="eval.html#spellsuggest()">spellsuggest()</A>|. The number of
suggestions is never more than the value of <A HREF="#'lines'">'lines'</A>
minus two.
file:{filename} Read file {filename}, which must have two columns,
separated by a slash. The first column contains the
bad <A HREF="motion.html#word">word</A>, the second column the suggested good <A HREF="motion.html#word">word</A>.
Example:
<B><FONT COLOR="PURPLE"> theribal/terrible </FONT></B>
Use this for common mistakes that <A HREF="diff.html#do">do</A> not appear at the
top of the suggestion <A HREF="eval.html#list">list</A> with the internal methods.
Lines without a slash are ignored, use this for
comments.
The <A HREF="motion.html#word">word</A> in the second column must be correct,
otherwise <A HREF="motion.html#it">it</A> will not be used. Add the <A HREF="motion.html#word">word</A> to an
".add" file if <A HREF="motion.html#it">it</A> is currently flagged <A HREF="motion.html#as">as</A> a spelling
mistake.
The file is used for all languages.
expr:{expr} Evaluate <A HREF="eval.html#expression">expression</A> {expr}. Use a function to avoid
trouble with spaces. |<A HREF="eval.html#v:val">v:val</A>| holds the badly spelled
<A HREF="motion.html#word">word</A>. The <A HREF="eval.html#expression">expression</A> must evaluate to a <A HREF="eval.html#List">List</A> of
<A HREF="eval.html#Lists">Lists</A>, each with a suggestion and a score.
Example:
<B><FONT COLOR="PURPLE"> [['the', 33], ['that', 44]] </FONT></B>
Set <A HREF="#'verbose'">'verbose'</A> and use |<A HREF="spell.html#z=">z=</A>| to see the scores that the
internal methods use. A lower score is better.
This may invoke |<A HREF="eval.html#spellsuggest()">spellsuggest()</A>| if you temporarily
set <A HREF="#'spellsuggest'">'spellsuggest'</A> to exclude the "expr:" part.
Errors are silently ignored, unless you set the
<A HREF="#'verbose'">'verbose'</A> option to a non-zero value.
Only one of "best", "double" or "fast" may be used. The others may
appear several times in any order. Example:
<B> :set sps=file:~/.vim/sugg,best,expr:MySuggest()</B>
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'splitbelow'"></A><B>'splitbelow'</B>* *<A NAME="'sb'"></A><B>'sb'</B>* *<A NAME="'nosplitbelow'"></A><B>'nosplitbelow'</B>* *<A NAME="'nosb'"></A><B>'nosb'</B>*
<A HREF="#'splitbelow'">'splitbelow'</A> <A HREF="#'sb'">'sb'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+windows">+windows</A>|
feature}
When on, splitting a <A HREF="windows.html#window">window</A> will put the new <A HREF="windows.html#window">window</A> below the current
one. |<A HREF="windows.html#:split">:split</A>|
*<A NAME="'splitright'"></A><B>'splitright'</B>* *<A NAME="'spr'"></A><B>'spr'</B>* *<A NAME="'nosplitright'"></A><B>'nosplitright'</B>* *<A NAME="'nospr'"></A><B>'nospr'</B>*
<A HREF="#'splitright'">'splitright'</A> <A HREF="#'spr'">'spr'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+vertsplit">+vertsplit</A>|
feature}
When on, splitting a <A HREF="windows.html#window">window</A> will put the new <A HREF="windows.html#window">window</A> right of the
current one. |<A HREF="windows.html#:vsplit">:vsplit</A>|
*<A NAME="'startofline'"></A><B>'startofline'</B>* *<A NAME="'sol'"></A><B>'sol'</B>* *<A NAME="'nostartofline'"></A><B>'nostartofline'</B>* *<A NAME="'nosol'"></A><B>'nosol'</B>*
<A HREF="#'startofline'">'startofline'</A> <A HREF="#'sol'">'sol'</A> <A HREF="#boolean">boolean</A> (default on)
global
{not in Vi}
When "on" the commands listed below move the cursor to the first
non-blank of the line. When off the cursor is kept in the same column
(if possible). This applies to the commands: <A HREF="scroll.html#CTRL-D">CTRL-D</A>, <A HREF="scroll.html#CTRL-U">CTRL-U</A>, <A HREF="scroll.html#CTRL-B">CTRL-B</A>,
<A HREF="scroll.html#CTRL-F">CTRL-F</A>, "<A HREF="motion.html#G">G</A>", "<A HREF="motion.html#H">H</A>", "<A HREF="motion.html#M">M</A>", "<A HREF="motion.html#L">L</A>", <A HREF="motion.html#gg">gg</A>, and to the commands "<A HREF="change.html#d">d</A>", "<A HREF="change.html#<<"><<</A>" and "<A HREF="change.html#>>">>></A>"
with a <A HREF="motion.html#linewise">linewise</A> <A HREF="motion.html#operator">operator</A>, with "<A HREF="motion.html#%">%</A>" with a <A HREF="intro.html#count">count</A> and to buffer <A HREF="change.html#changing">changing</A>
commands (CTRL-^, <A HREF="windows.html#:bnext">:bnext</A>, <A HREF="windows.html#:bNext">:bNext</A>, etc.). Also for an <A HREF="intro.html#Ex">Ex</A> command that
only has a line number, e.g., ":25" or ":+".
In <A HREF="change.html#case">case</A> of buffer <A HREF="change.html#changing">changing</A> commands the cursor is placed at the column
where <A HREF="motion.html#it">it</A> was the last time the buffer was edited.
NOTE: This option is set when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'statusline'"></A><B>'statusline'</B>* *<A NAME="'stl'"></A><B>'stl'</B>* *<A NAME="E540"></A><B>E540</B>* *<A NAME="E542"></A><B>E542</B>*
<A HREF="#'statusline'">'statusline'</A> <A HREF="#'stl'">'stl'</A> <A HREF="eval.html#string">string</A> (default empty)
global or local to <A HREF="windows.html#window">window</A> |<A HREF="#global-local">global-local</A>|
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+statusline">+statusline</A>|
feature}
When nonempty, this option determines the content of the status line.
Also see |<A HREF="windows.html#status-line">status-line</A>|.
The option consists of printf style '<A HREF="motion.html#%">%</A>' items interspersed with
normal text. Each status line item is of the form:
%-0{minwid}.{maxwid}{item}
All fields except the {item} are optional. A single percent sign can
be given <A HREF="motion.html#as">as</A> "%%". Up to 80 items can be specified. *<A NAME="E541"></A><B>E541</B>*
When the option starts with "%!" then <A HREF="motion.html#it">it</A> is used <A HREF="motion.html#as">as</A> an <A HREF="eval.html#expression">expression</A>,
evaluated and the result is used <A HREF="motion.html#as">as</A> the option value. Example:
<B> :set statusline=%!MyStatusLine()</B>
The result can contain %{} items that will be evaluated too.
Note that the "%!" <A HREF="eval.html#expression">expression</A> is evaluated in the context of the
current <A HREF="windows.html#window">window</A> and buffer, while %{} items are evaluated in the
context of the <A HREF="windows.html#window">window</A> that the statusline belongs to.
When there is error while evaluating the option then <A HREF="motion.html#it">it</A> will be made
empty to avoid further <A HREF="message.html#errors">errors</A>. Otherwise screen updating would loop.
Note that the only effect of <A HREF="#'ruler'">'ruler'</A> when this option is set (and
<A HREF="#'laststatus'">'laststatus'</A> is 2) is controlling the output of |<A HREF="editing.html#CTRL-G">CTRL-G</A>|.
<B><FONT COLOR="PURPLE"> field meaning </FONT></B>
- Left justify the item. The default is right justified
when minwid is larger than the length of the item.
0 Leading zeroes in numeric items. Overridden by '<A HREF="motion.html#-">-</A>'.
minwid Minimum width of the item, padding <A HREF="motion.html#as">as</A> set by '<A HREF="motion.html#-">-</A>' <A HREF="change.html#&">&</A> '<A HREF="motion.html#0">0</A>'.
Value must be 50 or <A HREF="various.html#less">less</A>.
maxwid Maximum width of the item. Truncation occurs with a '<A HREF="change.html#<"><</A>'
on the left for text items. Numeric items will be
shifted down to maxwid-2 digits followed by '>'number
where number is the amount of missing digits, much like
an exponential <A HREF="intro.html#notation">notation</A>.
item A one <A HREF="print.html#letter">letter</A> code <A HREF="motion.html#as">as</A> described below.
Following is a description of the possible statusline items. The
second character in "item" is the type:
N for number
<A HREF="change.html#S">S</A> for <A HREF="eval.html#string">string</A>
<A HREF="motion.html#F">F</A> for flags <A HREF="motion.html#as">as</A> described below
- not applicable
<B><FONT COLOR="PURPLE"> item meaning </FONT></B>
<A HREF="motion.html#f">f</A> <A HREF="change.html#S">S</A> Path to the file in the buffer, <A HREF="motion.html#as">as</A> typed or relative to current
directory.
<A HREF="motion.html#F">F</A> <A HREF="change.html#S">S</A> Full path to the file in the buffer.
t <A HREF="change.html#S">S</A> File name (tail) of file in the buffer.
<A HREF="motion.html#m">m</A> <A HREF="motion.html#F">F</A> Modified flag, text is "[+]"; "[-]" if <A HREF="#'modifiable'">'modifiable'</A> is off.
<A HREF="motion.html#M">M</A> <A HREF="motion.html#F">F</A> Modified flag, text is ",+" or ",-".
<A HREF="change.html#r">r</A> <A HREF="motion.html#F">F</A> Readonly flag, text is "[RO]".
<A HREF="change.html#R">R</A> <A HREF="motion.html#F">F</A> Readonly flag, text is ",RO".
<A HREF="motion.html#h">h</A> <A HREF="motion.html#F">F</A> Help buffer flag, text is "[help]".
<A HREF="motion.html#H">H</A> <A HREF="motion.html#F">F</A> Help buffer flag, text is ",HLP".
<A HREF="motion.html#w">w</A> <A HREF="motion.html#F">F</A> Preview <A HREF="windows.html#window">window</A> flag, text is "[Preview]".
<A HREF="motion.html#W">W</A> <A HREF="motion.html#F">F</A> Preview <A HREF="windows.html#window">window</A> flag, text is ",PRV".
<A HREF="change.html#y">y</A> <A HREF="motion.html#F">F</A> Type of file in the buffer, e.g., "[vim]". See <A HREF="#'filetype'">'filetype'</A>.
<A HREF="change.html#Y">Y</A> <A HREF="motion.html#F">F</A> Type of file in the buffer, e.g., ",VIM". See <A HREF="#'filetype'">'filetype'</A>.
{not available when compiled without |<A HREF="various.html#+autocmd">+autocmd</A>| feature}
<A HREF="repeat.html#q">q</A> <A HREF="change.html#S">S</A> "[Quickfix List]", "[Location List]" or empty.
<A HREF="motion.html#k">k</A> <A HREF="change.html#S">S</A> Value of "b:keymap_name" or <A HREF="#'keymap'">'keymap'</A> when |<A HREF="map.html#:lmap">:lmap</A>| mappings are
being used: "<keymap>"
<A HREF="pattern.html#n">n</A> N Buffer number.
<A HREF="motion.html#b">b</A> N Value of character under cursor.
<A HREF="motion.html#B">B</A> N As above, in hexadecimal.
<A HREF="insert.html#o">o</A> N Byte number in file of byte under cursor, first byte is 1.
Mnemonic: Offset from start of file (with one added)
{not available when compiled without |<A HREF="various.html#+byte_offset">+byte_offset</A>| feature}
<A HREF="insert.html#O">O</A> N As above, in hexadecimal.
N N Printer page number. (Only works in the <A HREF="#'printheader'">'printheader'</A> option.)
<A HREF="motion.html#l">l</A> N Line number.
<A HREF="motion.html#L">L</A> N <A HREF="eval.html#Number">Number</A> of lines in buffer.
<A HREF="change.html#c">c</A> N Column number.
<A HREF="visual.html#v">v</A> N Virtual column number.
<A HREF="visual.html#V">V</A> N Virtual column number <A HREF="motion.html#as">as</A> -{num}. Not displayed if equal to '<A HREF="change.html#c">c</A>'.
<A HREF="change.html#p">p</A> N Percentage through file in lines <A HREF="motion.html#as">as</A> in |<A HREF="editing.html#CTRL-G">CTRL-G</A>|.
<A HREF="change.html#P">P</A> <A HREF="change.html#S">S</A> Percentage through file of displayed <A HREF="windows.html#window">window</A>. This is like the
percentage described for <A HREF="#'ruler'">'ruler'</A>. Always 3 in length, unless
translated.
a <A HREF="change.html#S">S</A> Argument <A HREF="eval.html#list">list</A> status <A HREF="motion.html#as">as</A> in default title. ({current} of {max})
Empty if the argument file <A HREF="intro.html#count">count</A> is zero or one.
{ NF Evaluate <A HREF="eval.html#expression">expression</A> between '%{' and '<A HREF="motion.html#}">}</A>' and substitute result.
Note that there is no '<A HREF="motion.html#%">%</A>' before the closing '<A HREF="motion.html#}">}</A>'.
( - Start of item group. Can be used for setting the width and
alignment of a section. Must be followed by <A HREF="motion.html#%">%</A>) somewhere.
) - End of item group. No width fields allowed.
<A HREF="motion.html#T">T</A> N For <A HREF="#'tabline'">'tabline'</A>: start of <A HREF="intro.html#tab">tab</A> page N label. Use %T after the last
label. This information is used for mouse clicks.
X N For <A HREF="#'tabline'">'tabline'</A>: start of close <A HREF="intro.html#tab">tab</A> N label. Use %X after the
label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
<A HREF="motion.html#mark">mark</A>. This information is used for mouse clicks.
<A HREF="change.html#<"><</A> - Where to truncate line if too long. Default is at the start.
No width fields allowed.
= - Separation point between left and right aligned items.
No width fields allowed.
# - Set highlight group. The name must follow and then a # again.
Thus use %#HLname# for highlight group HLname. The same
highlighting is used, also for the statusline of non-current
<A HREF="windows.html#windows">windows</A>.
* - Set highlight group to User{N}, where {N} is taken from the
minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
The difference between User{N} and StatusLine will be applied
to StatusLineNC for the statusline of non-current <A HREF="windows.html#windows">windows</A>.
The number N must be between 1 and 9. See |<A HREF="syntax.html#hl-User1..9">hl-User1..9</A>|
When displaying a flag, Vim removes the leading comma, if any, when
that flag comes right after plaintext. This will make a <A HREF="todo.html#nice">nice</A> display
when flags are used like in the examples below.
When all items in a group becomes an empty <A HREF="eval.html#string">string</A> (i.e. flags that are
not set) and a minwid is not set for the group, the whole group will
become empty. This will make a group like the following disappear
completely from the statusline when none of the flags are set.
<B> :set statusline=...%(\ [%M%R%H]%)...</B>
*<A NAME="g:actual_curbuf"></A><B>g:actual_curbuf</B>*
Beware that an <A HREF="eval.html#expression">expression</A> is evaluated each and every time the status
line is displayed. The current buffer and current <A HREF="windows.html#window">window</A> will be set
temporarily to that of the <A HREF="windows.html#window">window</A> (and buffer) whose statusline is
currently being drawn. The <A HREF="eval.html#expression">expression</A> will evaluate in this context.
The variable "actual_curbuf" is set to the '<A HREF="eval.html#bufnr()">bufnr()</A>' number of the
real current buffer.
The <A HREF="#'statusline'">'statusline'</A> option will be evaluated in the |<A HREF="eval.html#sandbox">sandbox</A>| if set from
a <A HREF="#modeline">modeline</A>, see |<A HREF="eval.html#sandbox-option">sandbox-option</A>|.
It is not allowed to change text or jump to another <A HREF="windows.html#window">window</A> while
evaluating <A HREF="#'statusline'">'statusline'</A> |<A HREF="eval.html#textlock">textlock</A>|.
If the statusline is not updated when you want <A HREF="motion.html#it">it</A> (e.g., after setting
a variable that's used in an expression), you can force an update by
setting an option without <A HREF="change.html#changing">changing</A> its value. Example:
<B> :let &ro = &ro</B>
A result of all digits is regarded a number for display purposes.
Otherwise the result is taken <A HREF="motion.html#as">as</A> flag text and applied to the rules
described above.
Watch out for <A HREF="message.html#errors">errors</A> in expressions. They may render Vim unusable!
If you are stuck, hold down '<A HREF="cmdline.html#:">:</A>' or '<A HREF="intro.html#Q">Q</A>' to get a prompt, then quit and
edit your <A HREF="starting.html#.vimrc">.vimrc</A> or whatever with "vim --clean" to get <A HREF="motion.html#it">it</A> right.
Examples:
Emulate standard status line with <A HREF="#'ruler'">'ruler'</A> set
<B> :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P</B>
Similar, but add ASCII value of char under the cursor (like "<A HREF="various.html#ga">ga</A>")
<B> :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P</B>
Display byte <A HREF="intro.html#count">count</A> and byte value, modified flag in red.
<B> :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'</B>
<B> :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red</B>
Display a ,GZ flag if a compressed file is loaded
<B> :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...</B>
In the YXXY:autocmd|'s:
<B> :let b:gzflag = 1</B>
And:
<B> :unlet b:gzflag</B>
And define this function:
<B> :function VarExists(var, val)</B>
<B> : if exists(a:var) | return a:val | else | return '' | endif</B>
<B> :endfunction</B>
*<A NAME="'suffixes'"></A><B>'suffixes'</B>* *<A NAME="'su'"></A><B>'su'</B>*
<A HREF="#'suffixes'">'suffixes'</A> <A HREF="#'su'">'su'</A> <A HREF="eval.html#string">string</A> (default ".bak,~,.o,.h,.info,.swp,.obj")
global
{not in Vi}
Files with these <A HREF="cmdline.html#suffixes">suffixes</A> get a lower priority when multiple files
match a <A HREF="editing.html#wildcard">wildcard</A>. See |<A HREF="cmdline.html#suffixes">suffixes</A>|. Commas can be used to separate the
<A HREF="cmdline.html#suffixes">suffixes</A>. Spaces after the comma are ignored. A dot is also seen <A HREF="motion.html#as">as</A>
the start of a suffix. To avoid a dot or comma being recognized <A HREF="motion.html#as">as</A> a
separator, precede <A HREF="motion.html#it">it</A> with a backslash (see |<A HREF="#option-backslash">option-backslash</A>| about
including spaces and backslashes).
See <A HREF="#'wildignore'">'wildignore'</A> for completely ignoring files.
The use of |<A HREF="#:set+=">:set+=</A>| and |<A HREF="#:set-=">:set-=</A>| is preferred when adding or removing
<A HREF="cmdline.html#suffixes">suffixes</A> from the <A HREF="eval.html#list">list</A>. This avoids problems when a future version
uses another default.
*<A NAME="'suffixesadd'"></A><B>'suffixesadd'</B>* *<A NAME="'sua'"></A><B>'sua'</B>*
<A HREF="#'suffixesadd'">'suffixesadd'</A> <A HREF="#'sua'">'sua'</A> <A HREF="eval.html#string">string</A> (default "")
local to buffer
{not in Vi}
{not available when compiled without the
|<A HREF="various.html#+file_in_path">+file_in_path</A>| feature}
Comma separated <A HREF="eval.html#list">list</A> of <A HREF="cmdline.html#suffixes">suffixes</A>, which are used when searching for a
file for the "<A HREF="editing.html#gf">gf</A>", "<A HREF="tagsrch.html#[I">[I</A>", etc. commands. Example:
<B> :set suffixesadd=.java</B>
*<A NAME="'swapfile'"></A><B>'swapfile'</B>* *<A NAME="'swf'"></A><B>'swf'</B>* *<A NAME="'noswapfile'"></A><B>'noswapfile'</B>* *<A NAME="'noswf'"></A><B>'noswf'</B>*
<A HREF="#'swapfile'">'swapfile'</A> <A HREF="#'swf'">'swf'</A> <A HREF="#boolean">boolean</A> (default on)
local to buffer
{not in Vi}
Use a swapfile for the buffer. This option can be reset when a
swapfile is not wanted for a specific buffer. For example, with
confidential information that even root must not be able to access.
Careful: All text will be in memory:
- Don't use this for big files.
- Recovery will be impossible!
A swapfile will only be present when |<A HREF="#'updatecount'">'updatecount'</A>| is non-zero and
<A HREF="#'swapfile'">'swapfile'</A> is set.
When <A HREF="#'swapfile'">'swapfile'</A> is reset, the swap file for the current buffer is
immediately deleted. When <A HREF="#'swapfile'">'swapfile'</A> is set, and <A HREF="#'updatecount'">'updatecount'</A> is
non-zero, a swap file is immediately created.
Also see |<A HREF="recover.html#swap-file">swap-file</A>| and |<A HREF="#'swapsync'">'swapsync'</A>|.
If you want to open a new buffer without creating a swap file for <A HREF="motion.html#it">it</A>,
use the |<A HREF="recover.html#:noswapfile">:noswapfile</A>| modifier.
This option is used together with <A HREF="#'bufhidden'">'bufhidden'</A> and <A HREF="#'buftype'">'buftype'</A> to
specify special kinds of buffers. See |<A HREF="windows.html#special-buffers">special-buffers</A>|.
*<A NAME="'swapsync'"></A><B>'swapsync'</B>* *<A NAME="'sws'"></A><B>'sws'</B>*
<A HREF="#'swapsync'">'swapsync'</A> <A HREF="#'sws'">'sws'</A> <A HREF="eval.html#string">string</A> (default "fsync")
global
{not in Vi}
When this option is not empty a swap file is synced to disk after
<A HREF="editing.html#writing">writing</A> to <A HREF="motion.html#it">it</A>. This takes some time, especially on busy <A HREF="os_unix.html#unix">unix</A> systems.
When this option is empty parts of the swap file may be in memory and
not written to disk. When the system crashes you may lose more work.
On <A HREF="os_unix.html#Unix">Unix</A> the system does a sync now and then without Vim asking for <A HREF="motion.html#it">it</A>,
so the disadvantage of setting this option off is small. On some
systems the swap file will not be written at all. For a <A HREF="os_unix.html#unix">unix</A> system
setting <A HREF="motion.html#it">it</A> to "sync" will use the sync() call instead of the default
fsync(), which may work better on some systems.
The <A HREF="#'fsync'">'fsync'</A> option is used for the actual file.
*<A NAME="'switchbuf'"></A><B>'switchbuf'</B>* *<A NAME="'swb'"></A><B>'swb'</B>*
<A HREF="#'switchbuf'">'switchbuf'</A> <A HREF="#'swb'">'swb'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not in Vi}
This option controls the behavior when switching between <A HREF="windows.html#buffers">buffers</A>.
Possible values (comma separated list):
useopen If included, jump to the first open <A HREF="windows.html#window">window</A> that
contains the specified buffer (if there is one).
Otherwise: Do not examine other <A HREF="windows.html#windows">windows</A>.
This setting is checked with |<A HREF="quickfix.html#quickfix">quickfix</A>| commands, when
jumping to <A HREF="message.html#errors">errors</A> (":cc", "<A HREF="quickfix.html#:cn">:cn</A>", "cp", etc.). It is
also used in all buffer related split commands, for
example "<A HREF="windows.html#:sbuffer">:sbuffer</A>", "<A HREF="windows.html#:sbnext">:sbnext</A>", or "<A HREF="windows.html#:sbrewind">:sbrewind</A>".
usetab Like "useopen", but also consider <A HREF="windows.html#windows">windows</A> in other <A HREF="intro.html#tab">tab</A>
pages.
split If included, split the current <A HREF="windows.html#window">window</A> before loading
a buffer for a |<A HREF="quickfix.html#quickfix">quickfix</A>| command that display <A HREF="message.html#errors">errors</A>.
Otherwise: <A HREF="diff.html#do">do</A> not split, use current <A HREF="windows.html#window">window</A>.
vsplit Just like "split" but split vertically.
newtab Like "split", but open a new <A HREF="intro.html#tab">tab</A> page. Overrules
"split" when both are present.
*<A NAME="'synmaxcol'"></A><B>'synmaxcol'</B>* *<A NAME="'smc'"></A><B>'smc'</B>*
<A HREF="#'synmaxcol'">'synmaxcol'</A> <A HREF="#'smc'">'smc'</A> number (default 3000)
local to buffer
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+syntax">+syntax</A>|
feature}
Maximum column in which to search for <A HREF="syntax.html#syntax">syntax</A> items. In long lines the
text after this column is not highlighted and following lines may not
be highlighted correctly, because the <A HREF="syntax.html#syntax">syntax</A> state is cleared.
This helps to avoid very slow redrawing for an XML file that is one
long line.
Set to zero to remove the limit.
*<A NAME="'syntax'"></A><B>'syntax'</B>* *<A NAME="'syn'"></A><B>'syn'</B>*
<A HREF="#'syntax'">'syntax'</A> <A HREF="#'syn'">'syn'</A> <A HREF="eval.html#string">string</A> (default empty)
local to buffer
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+syntax">+syntax</A>|
feature}
When this option is set, the <A HREF="syntax.html#syntax">syntax</A> with this name is loaded, unless
<A HREF="syntax.html#syntax">syntax</A> highlighting has been switched off with "<A HREF="syntax.html#:syntax">:syntax</A> off".
Otherwise this option does not always reflect the current <A HREF="syntax.html#syntax">syntax</A> (the
b:current_syntax variable does).
This option is most useful in a <A HREF="#modeline">modeline</A>, for a file which <A HREF="syntax.html#syntax">syntax</A> is
not automatically recognized. Example, in an IDL file:
<B><FONT COLOR="PURPLE"> /* vim: set syntax=idl : */ </FONT></B>
When a dot appears in the value then this separates two <A HREF="filetype.html#filetype">filetype</A>
names. Example:
<B><FONT COLOR="PURPLE"> /* vim: set syntax=c.doxygen : */ </FONT></B>
This will use the "<A HREF="change.html#c">c</A>" <A HREF="syntax.html#syntax">syntax</A> first, then the "doxygen" <A HREF="syntax.html#syntax">syntax</A>.
Note that the second one must be prepared to be loaded <A HREF="motion.html#as">as</A> an addition,
otherwise <A HREF="motion.html#it">it</A> will be skipped. More than one dot may appear.
To switch off <A HREF="syntax.html#syntax">syntax</A> highlighting for the current file, use:
<B> :set syntax=OFF</B>
To switch <A HREF="syntax.html#syntax">syntax</A> highlighting on according to the current value of the
<A HREF="#'filetype'">'filetype'</A> option:
<B> :set syntax=ON</B>
What actually happens when setting the <A HREF="#'syntax'">'syntax'</A> option is that the
<A HREF="autocmd.html#Syntax">Syntax</A> <A HREF="autocmd.html#autocommand">autocommand</A> event is triggered with the value <A HREF="motion.html#as">as</A> argument.
This option is not copied to another buffer, independent of the '<A HREF="change.html#s">s</A>' or
'<A HREF="change.html#S">S</A>' flag in <A HREF="#'cpoptions'">'cpoptions'</A>.
Only normal file name characters can be used, "/\*?[|<>" are illegal.
*<A NAME="'tabline'"></A><B>'tabline'</B>* *<A NAME="'tal'"></A><B>'tal'</B>*
<A HREF="#'tabline'">'tabline'</A> <A HREF="#'tal'">'tal'</A> <A HREF="eval.html#string">string</A> (default empty)
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+windows">+windows</A>|
feature}
When nonempty, this option determines the content of the <A HREF="intro.html#tab">tab</A> pages
line at the top of the Vim <A HREF="windows.html#window">window</A>. When empty Vim will use a default
tab pages line. See |<A HREF="tabpage.html#setting-tabline">setting-tabline</A>| for more info.
The <A HREF="intro.html#tab">tab</A> pages line only appears <A HREF="motion.html#as">as</A> specified with the <A HREF="#'showtabline'">'showtabline'</A>
option and only when there is no <A HREF="gui.html#GUI">GUI</A> <A HREF="intro.html#tab">tab</A> line. When '<A HREF="motion.html#e">e</A>' is in
<A HREF="#'guioptions'">'guioptions'</A> and the <A HREF="gui.html#GUI">GUI</A> supports a <A HREF="intro.html#tab">tab</A> line <A HREF="#'guitablabel'">'guitablabel'</A> is used
instead. Note that the two <A HREF="intro.html#tab">tab</A> pages lines are very different.
The value is evaluated like with <A HREF="#'statusline'">'statusline'</A>. You can use
|<A HREF="eval.html#tabpagenr()">tabpagenr()</A>|, |<A HREF="eval.html#tabpagewinnr()">tabpagewinnr()</A>| and |<A HREF="eval.html#tabpagebuflist()">tabpagebuflist()</A>| to figure out
the text to be displayed. Use "%1T" for the first label, "%2T" for
the second one, etc. Use "%X" items for closing labels.
Keep in mind that only one of the <A HREF="intro.html#tab">tab</A> pages is the current one, others
are invisible and you can't jump to their <A HREF="windows.html#windows">windows</A>.
*<A NAME="'tabpagemax'"></A><B>'tabpagemax'</B>* *<A NAME="'tpm'"></A><B>'tpm'</B>*
<A HREF="#'tabpagemax'">'tabpagemax'</A> <A HREF="#'tpm'">'tpm'</A> number (default 10)
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+windows">+windows</A>|
feature}
Maximum number of <A HREF="intro.html#tab">tab</A> pages to be opened by the |<A HREF="starting.html#-p">-p</A>| command line
argument or the "<A HREF="tabpage.html#:tab">:tab</A> all" command. |<A HREF="tabpage.html#tabpage">tabpage</A>|
*<A NAME="'tabstop'"></A><B>'tabstop'</B>* *<A NAME="'ts'"></A><B>'ts'</B>*
<A HREF="#'tabstop'">'tabstop'</A> <A HREF="#'ts'">'ts'</A> number (default 8)
local to buffer
<A HREF="eval.html#Number">Number</A> of spaces that a <A HREF="motion.html#<Tab>"><Tab></A> in the file counts for. Also see
|<A HREF="change.html#:retab">:retab</A>| command, and <A HREF="#'softtabstop'">'softtabstop'</A> option.
Note: Setting <A HREF="#'tabstop'">'tabstop'</A> to any other value than 8 can make your file
appear wrong in many places (e.g., when <A HREF="print.html#printing">printing</A> <A HREF="motion.html#it">it</A>).
There are four main ways to use tabs in Vim:
1. Always keep <A HREF="#'tabstop'">'tabstop'</A> at 8, set <A HREF="#'softtabstop'">'softtabstop'</A> and <A HREF="#'shiftwidth'">'shiftwidth'</A> to 4
(or 3 or whatever you prefer) and use <A HREF="#'noexpandtab'">'noexpandtab'</A>. Then Vim
will use a mix of tabs and spaces, but typing <A HREF="motion.html#<Tab>"><Tab></A> and <A HREF="motion.html#<BS>"><BS></A> will
behave like a <A HREF="intro.html#tab">tab</A> appears every 4 (or 3) characters.
2. Set <A HREF="#'tabstop'">'tabstop'</A> and <A HREF="#'shiftwidth'">'shiftwidth'</A> to whatever you prefer and use
<A HREF="#'expandtab'">'expandtab'</A>. This way you will always insert spaces. The
<A HREF="change.html#formatting">formatting</A> will never be messed up when <A HREF="#'tabstop'">'tabstop'</A> is changed.
3. Set <A HREF="#'tabstop'">'tabstop'</A> and <A HREF="#'shiftwidth'">'shiftwidth'</A> to whatever you prefer and use a
|<A HREF="#modeline">modeline</A>| to set these values when editing the file again. Only
works when using Vim to edit the file.
4. Always set <A HREF="#'tabstop'">'tabstop'</A> and <A HREF="#'shiftwidth'">'shiftwidth'</A> to the same value, and
<A HREF="#'noexpandtab'">'noexpandtab'</A>. This should then work (for initial indents only)
for any tabstop setting that people use. It might be <A HREF="todo.html#nice">nice</A> to have
tabs after the first non-blank inserted <A HREF="motion.html#as">as</A> spaces if you <A HREF="diff.html#do">do</A> this
though. Otherwise aligned comments will be wrong when <A HREF="#'tabstop'">'tabstop'</A> is
changed.
*<A NAME="'tagbsearch'"></A><B>'tagbsearch'</B>* *<A NAME="'tbs'"></A><B>'tbs'</B>* *<A NAME="'notagbsearch'"></A><B>'notagbsearch'</B>* *<A NAME="'notbs'"></A><B>'notbs'</B>*
<A HREF="#'tagbsearch'">'tagbsearch'</A> <A HREF="#'tbs'">'tbs'</A> <A HREF="#boolean">boolean</A> (default on)
global
{not in Vi}
When searching for a <A HREF="tagsrch.html#tag">tag</A> (e.g., for the |<A HREF="tagsrch.html#:ta">:ta</A>| command), Vim can either
use a binary search or a linear search in a <A HREF="tagsrch.html#tags">tags</A> file. Binary
searching makes searching for a <A HREF="tagsrch.html#tag">tag</A> a LOT faster, but a linear search
will find more <A HREF="tagsrch.html#tags">tags</A> if the <A HREF="tagsrch.html#tags">tags</A> file wasn't properly sorted.
Vim normally assumes that your <A HREF="tagsrch.html#tags">tags</A> files are sorted, or indicate that
they are not sorted. Only when this is not the <A HREF="change.html#case">case</A> does the
<A HREF="#'tagbsearch'">'tagbsearch'</A> option need to be switched off.
When <A HREF="#'tagbsearch'">'tagbsearch'</A> is on, binary searching is first used in the <A HREF="tagsrch.html#tags">tags</A>
files. In certain situations, Vim will <A HREF="diff.html#do">do</A> a linear search instead for
certain files, or retry all files with a linear search. When
<A HREF="#'tagbsearch'">'tagbsearch'</A> is off, only a linear search is done.
Linear searching is done anyway, for one file, when Vim finds a line
at the start of the file indicating that it's not sorted:
<B> !_TAG_FILE_SORTED 0 /some comment/</B>
[The <A HREF="pattern.html#whitespace">whitespace</A> before and after the '<A HREF="motion.html#0">0</A>' must be a single <Tab>]
When a binary search was done and no match was found in any of the
files listed in <A HREF="#'tags'">'tags'</A>, and <A HREF="change.html#case">case</A> is ignored or a <A HREF="pattern.html#pattern">pattern</A> is used
instead of a normal <A HREF="tagsrch.html#tag">tag</A> name, a retry is done with a linear search.
Tags in unsorted <A HREF="tagsrch.html#tags">tags</A> files, and matches with different <A HREF="change.html#case">case</A> will only
be found in the retry.
If a <A HREF="tagsrch.html#tag">tag</A> file indicates that <A HREF="motion.html#it">it</A> is case-fold sorted, the second,
linear search can be avoided when <A HREF="change.html#case">case</A> is ignored. Use a value of '2'
in the "!_TAG_FILE_SORTED" line for this. A <A HREF="tagsrch.html#tag">tag</A> file can be case-fold
sorted with the <A HREF="starting.html#-f">-f</A> switch to "sort" in most unices, <A HREF="motion.html#as">as</A> in the command:
"sort <A HREF="starting.html#-f">-f</A> <A HREF="starting.html#-o">-o</A> <A HREF="tagsrch.html#tags">tags</A> tags". For "Exuberant ctags" version 5.x or higher
(at least 5.5) the --sort=foldcase switch can be used for this <A HREF="motion.html#as">as</A>
well. Note that <A HREF="change.html#case">case</A> must be folded to <A HREF="change.html#uppercase">uppercase</A> for this to work.
By default, <A HREF="tagsrch.html#tag">tag</A> searches are case-sensitive. Case is ignored when
<A HREF="#'ignorecase'">'ignorecase'</A> is set and <A HREF="#'tagcase'">'tagcase'</A> is "followic", or when <A HREF="#'tagcase'">'tagcase'</A> is
"ignore".
Also when <A HREF="#'tagcase'">'tagcase'</A> is "followscs" and <A HREF="#'smartcase'">'smartcase'</A> is set, or
<A HREF="#'tagcase'">'tagcase'</A> is "smart", and the <A HREF="pattern.html#pattern">pattern</A> contains only <A HREF="change.html#lowercase">lowercase</A>
characters.
When <A HREF="#'tagbsearch'">'tagbsearch'</A> is off, <A HREF="tagsrch.html#tags">tags</A> searching is slower when a full match
exists, but faster when no full match exists. Tags in unsorted <A HREF="tagsrch.html#tags">tags</A>
files may only be found with <A HREF="#'tagbsearch'">'tagbsearch'</A> off.
When the <A HREF="tagsrch.html#tags">tags</A> file is not sorted, or sorted in a wrong way (not on
ASCII byte value), <A HREF="#'tagbsearch'">'tagbsearch'</A> should be off, or the line given above
must be included in the <A HREF="tagsrch.html#tags">tags</A> file.
This option doesn't affect commands that find all matching <A HREF="tagsrch.html#tags">tags</A> (e.g.,
command-line completion and ":help").
{Vi: always uses binary search in some versions}
*<A NAME="'tagcase'"></A><B>'tagcase'</B>* *<A NAME="'tc'"></A><B>'tc'</B>*
<A HREF="#'tagcase'">'tagcase'</A> <A HREF="#'tc'">'tc'</A> <A HREF="eval.html#string">string</A> (default "followic")
global or local to buffer |<A HREF="#global-local">global-local</A>|
{not in Vi}
This option specifies how <A HREF="change.html#case">case</A> is handled when searching the <A HREF="tagsrch.html#tags">tags</A>
file:
followic Follow the <A HREF="#'ignorecase'">'ignorecase'</A> option
followscs Follow the <A HREF="#'smartcase'">'smartcase'</A> and <A HREF="#'ignorecase'">'ignorecase'</A> <A HREF="#options">options</A>
ignore Ignore <A HREF="change.html#case">case</A>
match Match <A HREF="change.html#case">case</A>
smart Ignore <A HREF="change.html#case">case</A> unless an upper <A HREF="change.html#case">case</A> <A HREF="print.html#letter">letter</A> is used
NOTE: This option is set to the <A HREF="intro.html#Vi">Vi</A> default value when <A HREF="#'compatible'">'compatible'</A> is
set and to the Vim default value when <A HREF="#'compatible'">'compatible'</A> is reset.
*<A NAME="'taglength'"></A><B>'taglength'</B>* *<A NAME="'tl'"></A><B>'tl'</B>*
<A HREF="#'taglength'">'taglength'</A> <A HREF="#'tl'">'tl'</A> number (default 0)
global
If non-zero, <A HREF="tagsrch.html#tags">tags</A> are significant up to this number of characters.
*<A NAME="'tagrelative'"></A><B>'tagrelative'</B>* *<A NAME="'tr'"></A><B>'tr'</B>* *<A NAME="'notagrelative'"></A><B>'notagrelative'</B>* *<A NAME="'notr'"></A><B>'notr'</B>*
<A HREF="#'tagrelative'">'tagrelative'</A> <A HREF="#'tr'">'tr'</A> <A HREF="#boolean">boolean</A> (Vim default: on, <A HREF="intro.html#Vi">Vi</A> default: off)
global
{not in Vi}
If on and using a <A HREF="tagsrch.html#tags">tags</A> file in another directory, file names in that
<A HREF="tagsrch.html#tags">tags</A> file are relative to the directory where the <A HREF="tagsrch.html#tags">tags</A> file is.
NOTE: This option is set to the <A HREF="intro.html#Vi">Vi</A> default value when <A HREF="#'compatible'">'compatible'</A> is
set and to the Vim default value when <A HREF="#'compatible'">'compatible'</A> is reset.
*<A NAME="'tags'"></A><B>'tags'</B>* *<A NAME="'tag'"></A><B>'tag'</B>* *<A NAME="E433"></A><B>E433</B>*
<A HREF="#'tags'">'tags'</A> <A HREF="#'tag'">'tag'</A> <A HREF="eval.html#string">string</A> (default "./tags,tags", when compiled with
|+emacs_tags|: "./tags,./TAGS,tags,TAGS")
global or local to buffer |<A HREF="#global-local">global-local</A>|
Filenames for the <A HREF="tagsrch.html#tag">tag</A> command, separated by spaces or commas. To
include a space or comma in a file name, precede <A HREF="motion.html#it">it</A> with a <A HREF="intro.html#backslash">backslash</A>
(see |<A HREF="#option-backslash">option-backslash</A>| about including spaces and backslashes).
When a file name starts with "./", the '<A HREF="repeat.html#.">.</A>' is replaced with the path
of the current file. But only when the '<A HREF="change.html#d">d</A>' flag is not included in
<A HREF="#'cpoptions'">'cpoptions'</A>. Environment <A HREF="eval.html#variables">variables</A> are expanded |<A HREF="#:set_env">:set_env</A>|. Also see
|<A HREF="tagsrch.html#tags-option">tags-option</A>|.
"*", "**" and other <A HREF="editing.html#wildcards">wildcards</A> can be used to search for <A HREF="tagsrch.html#tags">tags</A> files in
a directory tree. See |<A HREF="editing.html#file-searching">file-searching</A>|. E.g., "/lib/**/tags" will
find all files named "<A HREF="tagsrch.html#tags">tags</A>" below "/lib". The filename itself cannot
contain <A HREF="editing.html#wildcards">wildcards</A>, <A HREF="motion.html#it">it</A> is used as-is. E.g., "/lib/**/tags?" will find
files called "tags?". {not available when compiled without the
|<A HREF="various.html#+path_extra">+path_extra</A>| feature}
The |<A HREF="eval.html#tagfiles()">tagfiles()</A>| function can be used to get a <A HREF="eval.html#list">list</A> of the file names
actually used.
If Vim was compiled with the |<A HREF="various.html#+emacs_tags">+emacs_tags</A>| feature, Emacs-style tag
files are also supported. They are automatically recognized. The
default value becomes "./tags,./TAGS,tags,TAGS", unless <A HREF="change.html#case">case</A>
differences are ignored (MS-Windows). |<A HREF="tagsrch.html#emacs-tags">emacs-tags</A>|
The use of |<A HREF="#:set+=">:set+=</A>| and |<A HREF="#:set-=">:set-=</A>| is preferred when adding or removing
file names from the <A HREF="eval.html#list">list</A>. This avoids problems when a future version
uses another default.
{Vi: default is "<A HREF="tagsrch.html#tags">tags</A> /usr/lib/tags"}
*<A NAME="'tagstack'"></A><B>'tagstack'</B>* *<A NAME="'tgst'"></A><B>'tgst'</B>* *<A NAME="'notagstack'"></A><B>'notagstack'</B>* *<A NAME="'notgst'"></A><B>'notgst'</B>*
<A HREF="#'tagstack'">'tagstack'</A> <A HREF="#'tgst'">'tgst'</A> <A HREF="#boolean">boolean</A> (default on)
global
{not in all versions of Vi}
When on, the |<A HREF="tagsrch.html#tagstack">tagstack</A>| is used normally. When off, a "<A HREF="tagsrch.html#:tag">:tag</A>" or
"<A HREF="tagsrch.html#:tselect">:tselect</A>" command with an argument will not push the <A HREF="tagsrch.html#tag">tag</A> onto the
<A HREF="tagsrch.html#tagstack">tagstack</A>. A following "<A HREF="tagsrch.html#:tag">:tag</A>" without an argument, a "<A HREF="tagsrch.html#:pop">:pop</A>" command or
any other command that uses the <A HREF="tagsrch.html#tagstack">tagstack</A> will use the unmodified
<A HREF="tagsrch.html#tagstack">tagstack</A>, but does change the pointer to the active entry.
Resetting this option is useful when using a "<A HREF="tagsrch.html#:tag">:tag</A>" command in a
<A HREF="map.html#mapping">mapping</A> which should not change the <A HREF="tagsrch.html#tagstack">tagstack</A>.
*<A NAME="'tcldll'"></A><B>'tcldll'</B>*
<A HREF="#'tcldll'">'tcldll'</A> <A HREF="eval.html#string">string</A> (default depends on the build)
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+tcl/dyn">+tcl/dyn</A>|
feature}
Specifies the name of the <A HREF="if_tcl.html#Tcl">Tcl</A> shared library. The default is
DYNAMIC_TCL_DLL, which was specified at compile time.
Environment <A HREF="eval.html#variables">variables</A> are expanded |<A HREF="#:set_env">:set_env</A>|.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'term'"></A><B>'term'</B>* *<A NAME="E529"></A><B>E529</B>* *<A NAME="E530"></A><B>E530</B>* *<A NAME="E531"></A><B>E531</B>*
<A HREF="#'term'">'term'</A> <A HREF="eval.html#string">string</A> (default is $TERM, if that fails:
in the <A HREF="gui.html#GUI">GUI</A>: "builtin_gui"
on <A HREF="os_amiga.html#Amiga">Amiga</A>: "amiga"
on <A HREF="os_beos.html#BeOS">BeOS</A>: "beos-ansi"
on <A HREF="os_mac.html#Mac">Mac</A>: "mac-ansi"
on <A HREF="os_mint.html#MiNT">MiNT</A>: "vt52"
on <A HREF="os_msdos.html#MS-DOS">MS-DOS</A>: "pcterm"
on <A HREF="os_os2.html#OS/2">OS/2</A>: "os2ansi"
on <A HREF="os_unix.html#Unix">Unix</A>: "ansi"
on <A HREF="os_vms.html#VMS">VMS</A>: "ansi"
on Win 32: "<A HREF="os_win32.html#win32">win32</A>")
global
Name of the <A HREF="terminal.html#terminal">terminal</A>. Used for choosing the <A HREF="terminal.html#terminal">terminal</A> <A HREF="intro.html#control">control</A>
characters. Environment <A HREF="eval.html#variables">variables</A> are expanded |<A HREF="#:set_env">:set_env</A>|.
For example:
<B> :set term=$TERM</B>
See |<A HREF="term.html#termcap">termcap</A>|.
*<A NAME="'termbidi'"></A><B>'termbidi'</B>* *<A NAME="'tbidi'"></A><B>'tbidi'</B>*
*<A NAME="'notermbidi'"></A><B>'notermbidi'</B>* *<A NAME="'notbidi'"></A><B>'notbidi'</B>*
<A HREF="#'termbidi'">'termbidi'</A> <A HREF="#'tbidi'">'tbidi'</A> <A HREF="#boolean">boolean</A> (default off, on for "mlterm")
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+arabic">+arabic</A>|
feature}
The <A HREF="terminal.html#terminal">terminal</A> is in charge of Bi-directionality of text (as specified
by <A HREF="mbyte.html#Unicode">Unicode</A>). The <A HREF="terminal.html#terminal">terminal</A> is also expected to <A HREF="diff.html#do">do</A> the required shaping
that some languages (such <A HREF="motion.html#as">as</A> <A HREF="arabic.html#Arabic">Arabic</A>) require.
Setting this option implies that <A HREF="#'rightleft'">'rightleft'</A> will not be set when
<A HREF="#'arabic'">'arabic'</A> is set and the value of <A HREF="#'arabicshape'">'arabicshape'</A> will be ignored.
Note that setting <A HREF="#'termbidi'">'termbidi'</A> has the immediate effect that
<A HREF="#'arabicshape'">'arabicshape'</A> is ignored, but <A HREF="#'rightleft'">'rightleft'</A> isn't changed automatically.
This option is reset when the <A HREF="gui.html#GUI">GUI</A> is started.
For further details see |<A HREF="arabic.html">arabic.txt</A>|.
*<A NAME="'termencoding'"></A><B>'termencoding'</B>* *<A NAME="'tenc'"></A><B>'tenc'</B>*
<A HREF="#'termencoding'">'termencoding'</A> <A HREF="#'tenc'">'tenc'</A> <A HREF="eval.html#string">string</A> (default ""; with <A HREF="gui_x11.html#GTK+">GTK+</A> <A HREF="gui.html#GUI">GUI</A>: "<A HREF="mbyte.html#utf-8">utf-8</A>"; with
<A HREF="os_mac.html#Macintosh">Macintosh</A> <A HREF="gui.html#GUI">GUI</A>: "macroman")
global
{only available when compiled with the |<A HREF="various.html#+multi_byte">+multi_byte</A>|
feature}
{not in Vi}
Encoding used for the <A HREF="terminal.html#terminal">terminal</A>. This specifies what character
encoding the keyboard produces and the display will understand. For
the <A HREF="gui.html#GUI">GUI</A> <A HREF="motion.html#it">it</A> only applies to the keyboard ('encoding' is used for the
display). Except for the <A HREF="os_mac.html#Mac">Mac</A> when <A HREF="#'macatsui'">'macatsui'</A> is off, then
<A HREF="#'termencoding'">'termencoding'</A> should be "macroman".
*<A NAME="E617"></A><B>E617</B>*
Note: This does not apply to the <A HREF="gui_x11.html#GTK+">GTK+</A> <A HREF="gui.html#GUI">GUI</A>. After the <A HREF="gui.html#GUI">GUI</A> has been
successfully initialized, <A HREF="#'termencoding'">'termencoding'</A> is forcibly set to "<A HREF="mbyte.html#utf-8">utf-8</A>".
Any attempts to set a different value will be rejected, and an error
message is shown.
For the <A HREF="os_win32.html#Win32">Win32</A> <A HREF="gui.html#GUI">GUI</A> and console versions <A HREF="#'termencoding'">'termencoding'</A> is not used,
because the <A HREF="os_win32.html#Win32">Win32</A> system always passes <A HREF="mbyte.html#Unicode">Unicode</A> characters.
When empty, the same encoding is used <A HREF="motion.html#as">as</A> for the <A HREF="#'encoding'">'encoding'</A> option.
This is the normal value.
Not all combinations for <A HREF="#'termencoding'">'termencoding'</A> and <A HREF="#'encoding'">'encoding'</A> are valid. See
|<A HREF="mbyte.html#encoding-table">encoding-table</A>|.
The value for this option must be supported by internal conversions or
<A HREF="eval.html#iconv()">iconv()</A>. When this is not possible no conversion will be done and you
will probably experience problems with non-ASCII characters.
Example: You are working with the <A HREF="mbyte.html#locale">locale</A> set to euc-jp (Japanese) and
want to edit a <A HREF="mbyte.html#UTF-8">UTF-8</A> file:
<B> :let &termencoding = &encoding</B>
<B> :set encoding=utf-8</B>
You need to <A HREF="diff.html#do">do</A> this when your system has no <A HREF="mbyte.html#locale">locale</A> support for <A HREF="mbyte.html#UTF-8">UTF-8</A>.
*<A NAME="'termguicolors'"></A><B>'termguicolors'</B>* *<A NAME="'tgc'"></A><B>'tgc'</B>*
<A HREF="#'termguicolors'">'termguicolors'</A> <A HREF="#'tgc'">'tgc'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
{not available when compiled without the
|<A HREF="various.html#+termguicolors">+termguicolors</A>| feature}
When on, uses |<A HREF="syntax.html#highlight-guifg">highlight-guifg</A>| and |<A HREF="syntax.html#highlight-guibg">highlight-guibg</A>| attributes in
the <A HREF="terminal.html#terminal">terminal</A> (thus using 24-bit color). Requires a ISO-8613-3
compatible <A HREF="terminal.html#terminal">terminal</A>.
If setting this option does not work (produces a colorless UI)
reading |<A HREF="term.html#xterm-true-color">xterm-true-color</A>| might help.
Note that the "cterm" attributes are still used, not the "<A HREF="gui.html#gui">gui</A>" ones.
NOTE: This option is reset when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'termkey'"></A><B>'termkey'</B>* *<A NAME="'tk'"></A><B>'tk'</B>*
<A HREF="#'termkey'">'termkey'</A> <A HREF="#'tk'">'tk'</A> <A HREF="eval.html#string">string</A> (default "")
local to <A HREF="windows.html#window">window</A>
{not in Vi}
The key that starts a <A HREF="index.html#CTRL-W">CTRL-W</A> command in a <A HREF="terminal.html#terminal">terminal</A> <A HREF="windows.html#window">window</A>. Other keys
are sent to the <A HREF="channel.html#job">job</A> running in the <A HREF="windows.html#window">window</A>.
The <A HREF="intro.html#<>"><></A> <A HREF="intro.html#notation">notation</A> can be used, e.g.:
<B> :set termkey=<C-L></B>
The <A HREF="eval.html#string">string</A> must be one key stroke but can be multiple bytes.
When not set <A HREF="index.html#CTRL-W">CTRL-W</A> is used, so that <A HREF="index.html#CTRL-W">CTRL-W</A> : gets you to the command
line. If <A HREF="#'termkey'">'termkey'</A> is set to <A HREF="various.html#CTRL-L">CTRL-L</A> then <A HREF="various.html#CTRL-L">CTRL-L</A> : gets you to the
command line.
*<A NAME="'termsize'"></A><B>'termsize'</B>* *<A NAME="'tms'"></A><B>'tms'</B>*
<A HREF="#'termsize'">'termsize'</A> <A HREF="#'tms'">'tms'</A> <A HREF="eval.html#string">string</A> (default "")
local to <A HREF="windows.html#window">window</A>
{not in Vi}
Size of the |<A HREF="terminal.html#terminal">terminal</A>| <A HREF="windows.html#window">window</A>. Format: {rows}x{columns}.
- When empty the <A HREF="terminal.html#terminal">terminal</A> gets the size from the <A HREF="windows.html#window">window</A>.
- When set (e.g., "24x80") the <A HREF="terminal.html#terminal">terminal</A> size is not adjusted to the
<A HREF="windows.html#window">window</A> size. If the <A HREF="windows.html#window">window</A> is smaller only the top-left part is
displayed.
When rows is zero then use the height of the <A HREF="windows.html#window">window</A>.
When columns is zero then use the width of the <A HREF="windows.html#window">window</A>.
For example: "30x0" uses 30 rows with the current <A HREF="windows.html#window">window</A> width.
Using "0x0" is the same <A HREF="motion.html#as">as</A> empty.
Note that the command running in the <A HREF="terminal.html#terminal">terminal</A> <A HREF="windows.html#window">window</A> may still change
the size of the <A HREF="terminal.html#terminal">terminal</A>. In that <A HREF="change.html#case">case</A> the Vim <A HREF="windows.html#window">window</A> will be
adjusted to that size, if possible.
*<A NAME="'terse'"></A><B>'terse'</B>* *<A NAME="'noterse'"></A><B>'noterse'</B>*
<A HREF="#'terse'">'terse'</A> <A HREF="#boolean">boolean</A> (default off)
global
When set: Add '<A HREF="change.html#s">s</A>' flag to <A HREF="#'shortmess'">'shortmess'</A> option (this makes the message
for a search that hits the start or end of the file not being
displayed). When reset: Remove '<A HREF="change.html#s">s</A>' flag from <A HREF="#'shortmess'">'shortmess'</A> option. {Vi
shortens a lot of messages}
*<A NAME="'textauto'"></A><B>'textauto'</B>* *<A NAME="'ta'"></A><B>'ta'</B>* *<A NAME="'notextauto'"></A><B>'notextauto'</B>* *<A NAME="'nota'"></A><B>'nota'</B>*
<A HREF="#'textauto'">'textauto'</A> <A HREF="#'ta'">'ta'</A> <A HREF="#boolean">boolean</A> (Vim default: on, <A HREF="intro.html#Vi">Vi</A> default: off)
global
{not in Vi}
This option is obsolete. Use <A HREF="#'fileformats'">'fileformats'</A>.
For backwards compatibility, when <A HREF="#'textauto'">'textauto'</A> is set, <A HREF="#'fileformats'">'fileformats'</A> is
set to the default value for the current system. When <A HREF="#'textauto'">'textauto'</A> is
reset, <A HREF="#'fileformats'">'fileformats'</A> is made empty.
NOTE: This option is set to the <A HREF="intro.html#Vi">Vi</A> default value when <A HREF="#'compatible'">'compatible'</A> is
set and to the Vim default value when <A HREF="#'compatible'">'compatible'</A> is reset.
*<A NAME="'textmode'"></A><B>'textmode'</B>* *<A NAME="'tx'"></A><B>'tx'</B>* *<A NAME="'notextmode'"></A><B>'notextmode'</B>* *<A NAME="'notx'"></A><B>'notx'</B>*
<A HREF="#'textmode'">'textmode'</A> <A HREF="#'tx'">'tx'</A> <A HREF="#boolean">boolean</A> (MS-DOS, <A HREF="os_win32.html#Win32">Win32</A> and <A HREF="os_os2.html#OS/2">OS/2</A>: default on,
others: default off)
local to buffer
{not in Vi}
This option is obsolete. Use <A HREF="#'fileformat'">'fileformat'</A>.
For backwards compatibility, when <A HREF="#'textmode'">'textmode'</A> is set, <A HREF="#'fileformat'">'fileformat'</A> is
set to "<A HREF="os_dos.html#dos">dos</A>". When <A HREF="#'textmode'">'textmode'</A> is reset, <A HREF="#'fileformat'">'fileformat'</A> is set to
"<A HREF="os_unix.html#unix">unix</A>".
*<A NAME="'textwidth'"></A><B>'textwidth'</B>* *<A NAME="'tw'"></A><B>'tw'</B>*
<A HREF="#'textwidth'">'textwidth'</A> <A HREF="#'tw'">'tw'</A> number (default 0)
local to buffer
{not in Vi}
Maximum width of text that is being inserted. A longer line will be
broken after white space to get this width. A zero value disables
this.
<A HREF="#'textwidth'">'textwidth'</A> is set to 0 when the <A HREF="#'paste'">'paste'</A> option is set and restored
when <A HREF="#'paste'">'paste'</A> is reset.
When <A HREF="#'textwidth'">'textwidth'</A> is zero, <A HREF="#'wrapmargin'">'wrapmargin'</A> may be used. See also
<A HREF="#'formatoptions'">'formatoptions'</A> and |<A HREF="insert.html#ins-textwidth">ins-textwidth</A>|.
When <A HREF="#'formatexpr'">'formatexpr'</A> is set <A HREF="motion.html#it">it</A> will be used to break the line.
NOTE: This option is set to 0 when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'thesaurus'"></A><B>'thesaurus'</B>* *<A NAME="'tsr'"></A><B>'tsr'</B>*
<A HREF="#'thesaurus'">'thesaurus'</A> <A HREF="#'tsr'">'tsr'</A> <A HREF="eval.html#string">string</A> (default "")
global or local to buffer |<A HREF="#global-local">global-local</A>|
{not in Vi}
<A HREF="eval.html#List">List</A> of file names, separated by commas, that are used to lookup words
for thesaurus completion commands |<A HREF="insert.html#i_CTRL-X_CTRL-T">i_CTRL-X_CTRL-T</A>|. Each line in
the file should contain words with similar meaning, separated by
non-keyword characters (white space is preferred). Maximum line
length is 510 bytes.
To obtain a file to be used here, check out this ftp site:
[Sorry this link doesn't work anymore, <A HREF="diff.html#do">do</A> you know the right one?]
<A HREF="ftp://ftp.ox.ac.uk/pub/wordlists/">ftp://ftp.ox.ac.uk/pub/wordlists/</A> First get the README file.
To include a comma in a file name precede <A HREF="motion.html#it">it</A> with a <A HREF="intro.html#backslash">backslash</A>. Spaces
after a comma are ignored, otherwise spaces are included in the file
name. See |<A HREF="#option-backslash">option-backslash</A>| about using backslashes.
The use of |<A HREF="#:set+=">:set+=</A>| and |<A HREF="#:set-=">:set-=</A>| is preferred when adding or removing
directories from the <A HREF="eval.html#list">list</A>. This avoids problems when a future version
uses another default.
Backticks cannot be used in this option for security reasons.
*<A NAME="'tildeop'"></A><B>'tildeop'</B>* *<A NAME="'top'"></A><B>'top'</B>* *<A NAME="'notildeop'"></A><B>'notildeop'</B>* *<A NAME="'notop'"></A><B>'notop'</B>*
<A HREF="#'tildeop'">'tildeop'</A> <A HREF="#'top'">'top'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
When on: The tilde command "<A HREF="change.html#~">~</A>" behaves like an <A HREF="motion.html#operator">operator</A>.
NOTE: This option is reset when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'timeout'"></A><B>'timeout'</B>* *<A NAME="'to'"></A><B>'to'</B>* *<A NAME="'notimeout'"></A><B>'notimeout'</B>* *<A NAME="'noto'"></A><B>'noto'</B>*
<A HREF="#'timeout'">'timeout'</A> <A HREF="#'to'">'to'</A> <A HREF="#boolean">boolean</A> (default on)
global
*<A NAME="'ttimeout'"></A><B>'ttimeout'</B>* *<A NAME="'nottimeout'"></A><B>'nottimeout'</B>*
<A HREF="#'ttimeout'">'ttimeout'</A> <A HREF="#boolean">boolean</A> (default off, set in |<A HREF="defaults.html">defaults.vim</A>|)
global
{not in Vi}
These two <A HREF="#options">options</A> together determine the behavior when part of a
mapped key sequence or keyboard code has been received:
<B><FONT COLOR="PURPLE"> 'timeout' 'ttimeout' action </FONT></B>
off off <A HREF="diff.html#do">do</A> not time out
on on or off time out on :mappings and key codes
off on time out on key codes
If both <A HREF="#options">options</A> are off, Vim will wait until either the complete
<A HREF="map.html#mapping">mapping</A> or key sequence has been received, or <A HREF="motion.html#it">it</A> is clear that there
is no <A HREF="map.html#mapping">mapping</A> or key sequence for the received characters. For
example: if you have mapped "vl" and Vim has received '<A HREF="visual.html#v">v</A>', the next
character is needed to see if the '<A HREF="visual.html#v">v</A>' is followed by an '<A HREF="motion.html#l">l</A>'.
When one of the <A HREF="#options">options</A> is on, Vim will wait for about 1 second for
the next character to arrive. After that the already received
characters are interpreted <A HREF="motion.html#as">as</A> single characters. The waiting time can
be changed with the <A HREF="#'timeoutlen'">'timeoutlen'</A> option.
On slow terminals or very busy systems timing out may cause
malfunctioning cursor keys. If both <A HREF="#options">options</A> are off, Vim waits
forever after an entered <A HREF="intro.html#<Esc>"><Esc></A> if there are key codes that start
with <A HREF="intro.html#<Esc>"><Esc></A>. You will have to type <A HREF="intro.html#<Esc>"><Esc></A> <A HREF="if_cscop.html#twice">twice</A>. If you <A HREF="diff.html#do">do</A> not have
problems with key codes, but would like to have :mapped key
sequences not timing out in 1 second, set the <A HREF="#'ttimeout'">'ttimeout'</A> option and
reset the <A HREF="#'timeout'">'timeout'</A> option.
NOTE: <A HREF="#'ttimeout'">'ttimeout'</A> is reset when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'timeoutlen'"></A><B>'timeoutlen'</B>* *<A NAME="'tm'"></A><B>'tm'</B>*
<A HREF="#'timeoutlen'">'timeoutlen'</A> <A HREF="#'tm'">'tm'</A> number (default 1000)
global
{not in all versions of Vi}
*<A NAME="'ttimeoutlen'"></A><B>'ttimeoutlen'</B>* *<A NAME="'ttm'"></A><B>'ttm'</B>*
<A HREF="#'ttimeoutlen'">'ttimeoutlen'</A> <A HREF="#'ttm'">'ttm'</A> number (default -1, set to 100 in |<A HREF="defaults.html">defaults.vim</A>|)
global
{not in Vi}
The time in milliseconds that is waited for a key code or mapped key
sequence to complete. Also used for CTRL-\ <A HREF="motion.html#CTRL-N">CTRL-N</A> and CTRL-\ <A HREF="editing.html#CTRL-G">CTRL-G</A>
when part of a command has been typed.
Normally only <A HREF="#'timeoutlen'">'timeoutlen'</A> is used and <A HREF="#'ttimeoutlen'">'ttimeoutlen'</A> is -1. When a
different timeout value for key codes is desired set <A HREF="#'ttimeoutlen'">'ttimeoutlen'</A> to
a non-negative number.
<B><FONT COLOR="PURPLE"> ttimeoutlen mapping delay key code delay </FONT></B>
<A HREF="change.html#<"><</A> 0 <A HREF="#'timeoutlen'">'timeoutlen'</A> <A HREF="#'timeoutlen'">'timeoutlen'</A>
>= 0 <A HREF="#'timeoutlen'">'timeoutlen'</A> <A HREF="#'ttimeoutlen'">'ttimeoutlen'</A>
The timeout only happens when the <A HREF="#'timeout'">'timeout'</A> and <A HREF="#'ttimeout'">'ttimeout'</A> <A HREF="#options">options</A>
tell so. A useful setting would be
<B> :set timeout timeoutlen=3000 ttimeoutlen=100</B>
(time out on <A HREF="map.html#mapping">mapping</A> after three seconds, time out on key codes after
a tenth of a second).
*<A NAME="'title'"></A><B>'title'</B>* *<A NAME="'notitle'"></A><B>'notitle'</B>*
<A HREF="#'title'">'title'</A> <A HREF="#boolean">boolean</A> (default off, on when title can be restored)
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+title">+title</A>|
feature}
When on, the title of the <A HREF="windows.html#window">window</A> will be set to the value of
<A HREF="#'titlestring'">'titlestring'</A> (if <A HREF="motion.html#it">it</A> is not empty), or to:
filename [+=-] (path) - VIM
Where:
filename the name of the file being edited
- indicates the file cannot be modified, <A HREF="#'ma'">'ma'</A> off
+ indicates the file was modified
= indicates the file is read-only
=+ indicates the file is read-only and modified
(path) is the path of the file being edited
- VIM the server name |<A HREF="eval.html#v:servername">v:servername</A>| or "VIM"
Only works if the <A HREF="terminal.html#terminal">terminal</A> supports setting <A HREF="windows.html#window">window</A> titles
(currently <A HREF="os_amiga.html#Amiga">Amiga</A> console, <A HREF="os_win32.html#Win32">Win32</A> console, all <A HREF="gui.html#GUI">GUI</A> versions and
terminals with a non- empty <A HREF="term.html#'t_ts'">'t_ts'</A> option - these are <A HREF="os_unix.html#Unix">Unix</A> xterm and
iris-ansi by default, where <A HREF="term.html#'t_ts'">'t_ts'</A> is taken from the builtin <A HREF="term.html#termcap">termcap</A>).
*<A NAME="X11"></A><B>X11</B>*
When Vim was compiled with HAVE_X11 defined, the original title will
be restored if possible. The output of "<A HREF="various.html#:version">:version</A>" will include "<A HREF="various.html#+X11">+X11</A>"
when HAVE_X11 was defined, otherwise <A HREF="motion.html#it">it</A> will be "-X11". This also
works for the icon name |<A HREF="#'icon'">'icon'</A>|.
But: When Vim was started with the |<A HREF="starting.html#-X">-X</A>| argument, restoring the title
will not work (except in the <A HREF="gui.html#GUI">GUI</A>).
If the title cannot be restored, <A HREF="motion.html#it">it</A> is set to the value of <A HREF="#'titleold'">'titleold'</A>.
You might want to restore the title outside of Vim then.
When using an xterm from a remote machine you can use this command:
rsh machine_name xterm <A HREF="gui_x11.html#-display">-display</A> $DISPLAY <A HREF="change.html#&">&</A>
then the WINDOWID environment variable should be inherited and the
title of the <A HREF="windows.html#window">window</A> should change back to what <A HREF="motion.html#it">it</A> should be after
<A HREF="starting.html#exiting">exiting</A> Vim.
*<A NAME="'titlelen'"></A><B>'titlelen'</B>*
<A HREF="#'titlelen'">'titlelen'</A> number (default 85)
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+title">+title</A>|
feature}
Gives the percentage of <A HREF="#'columns'">'columns'</A> to use for the length of the <A HREF="windows.html#window">window</A>
title. When the title is longer, only the end of the path name is
shown. A '<A HREF="change.html#<"><</A>' character before the path name is used to indicate this.
Using a percentage makes this adapt to the width of the <A HREF="windows.html#window">window</A>. But
<A HREF="motion.html#it">it</A> won't work perfectly, because the actual number of characters
available also depends on the font used and other things in the title
<A HREF="motion.html#bar">bar</A>. When <A HREF="#'titlelen'">'titlelen'</A> is zero the full path is used. Otherwise,
values from 1 to 30000 percent can be used.
<A HREF="#'titlelen'">'titlelen'</A> is also used for the <A HREF="#'titlestring'">'titlestring'</A> option.
*<A NAME="'titleold'"></A><B>'titleold'</B>*
<A HREF="#'titleold'">'titleold'</A> <A HREF="eval.html#string">string</A> (default "Thanks for flying Vim")
global
{not in Vi}
{only available when compiled with the |<A HREF="various.html#+title">+title</A>|
feature}
This option will be used for the <A HREF="windows.html#window">window</A> title when <A HREF="starting.html#exiting">exiting</A> Vim if the
original title cannot be restored. Only happens if <A HREF="#'title'">'title'</A> is on or
<A HREF="#'titlestring'">'titlestring'</A> is not empty.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'titlestring'"></A><B>'titlestring'</B>*
<A HREF="#'titlestring'">'titlestring'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+title">+title</A>|
feature}
When this option is not empty, <A HREF="motion.html#it">it</A> will be used for the title of the
<A HREF="windows.html#window">window</A>. This happens only when the <A HREF="#'title'">'title'</A> option is on.
Only works if the <A HREF="terminal.html#terminal">terminal</A> supports setting <A HREF="windows.html#window">window</A> titles (currently
<A HREF="os_amiga.html#Amiga">Amiga</A> console, <A HREF="os_win32.html#Win32">Win32</A> console, all <A HREF="gui.html#GUI">GUI</A> versions and terminals with a
non-empty <A HREF="term.html#'t_ts'">'t_ts'</A> option).
When Vim was compiled with HAVE_X11 defined, the original title will
be restored if possible, see |<A HREF="#X11">X11</A>|.
When this option contains printf-style '<A HREF="motion.html#%">%</A>' items, they will be
expanded according to the rules used for <A HREF="#'statusline'">'statusline'</A>.
Example:
<B> :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")</B>
<B> :set title titlestring=%<%F%=%l/%L-%P titlelen=70</B>
The value of <A HREF="#'titlelen'">'titlelen'</A> is used to align items in the middle or right
of the available space.
Some people prefer to have the file name first:
<B> :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)</B>
Note the use of "%{ }" and an <A HREF="eval.html#expression">expression</A> to get the path of the file,
without the file name. The "%( %)" constructs are used to add a
separating space only when needed.
NOTE: Use of special characters in <A HREF="#'titlestring'">'titlestring'</A> may cause the display
to be garbled (e.g., when <A HREF="motion.html#it">it</A> contains a CR or NL character).
{not available when compiled without the |<A HREF="various.html#+statusline">+statusline</A>| feature}
*<A NAME="'toolbar'"></A><B>'toolbar'</B>* *<A NAME="'tb'"></A><B>'tb'</B>*
<A HREF="#'toolbar'">'toolbar'</A> <A HREF="#'tb'">'tb'</A> <A HREF="eval.html#string">string</A> (default "icons,tooltips")
global
{only for |<A HREF="various.html#+GUI_GTK">+GUI_GTK</A>|, |<A HREF="various.html#+GUI_Athena">+GUI_Athena</A>|, |<A HREF="various.html#+GUI_Motif">+GUI_Motif</A>| and
YXXY+GUI_Photon|}
The contents of this option controls various toolbar settings. The
possible values are:
icons Toolbar buttons are shown with icons.
text Toolbar buttons shown with text.
horiz Icon and text of a toolbar button are
horizontally arranged. {only in <A HREF="gui_x11.html#GTK+">GTK+</A> 2 GUI}
tooltips Tooltips are active for toolbar buttons.
Tooltips refer to the popup help text which appears after the mouse
cursor is placed over a toolbar button for a brief moment.
If you want the toolbar to be shown with icons <A HREF="motion.html#as">as</A> well <A HREF="motion.html#as">as</A> text, <A HREF="diff.html#do">do</A> the
following:
<B> :set tb=icons,text</B>
<A HREF="gui_x11.html#Motif">Motif</A> and <A HREF="gui_x11.html#Athena">Athena</A> cannot display icons and text at the same time. They
will show icons if both are requested.
If none of the strings specified in <A HREF="#'toolbar'">'toolbar'</A> are valid or if
<A HREF="#'toolbar'">'toolbar'</A> is empty, this option is ignored. If you want to disable
the toolbar, you need to set the <A HREF="#'guioptions'">'guioptions'</A> option. For example:
<B> :set guioptions-=T</B>
Also see |<A HREF="gui.html#gui-toolbar">gui-toolbar</A>|.
*<A NAME="'toolbariconsize'"></A><B>'toolbariconsize'</B>* *<A NAME="'tbis'"></A><B>'tbis'</B>*
<A HREF="#'toolbariconsize'">'toolbariconsize'</A> <A HREF="#'tbis'">'tbis'</A> <A HREF="eval.html#string">string</A> (default "small")
global
{not in Vi}
{only in the <A HREF="gui_x11.html#GTK+">GTK+</A> GUI}
Controls the size of toolbar icons. The possible values are:
tiny Use tiny icons.
small Use small icons (default).
medium Use medium-sized icons.
large Use large icons.
huge Use even larger icons.
giant Use very big icons.
The exact dimensions in pixels of the various icon sizes depend on
the current theme. Common dimensions are giant=48x48, huge=32x32,
large=24x24, medium=24x24, small=20x20 and tiny=16x16.
If <A HREF="#'toolbariconsize'">'toolbariconsize'</A> is empty, the global default size <A HREF="motion.html#as">as</A> determined
by user preferences or the current theme is used.
*<A NAME="'ttybuiltin'"></A><B>'ttybuiltin'</B>* *<A NAME="'tbi'"></A><B>'tbi'</B>* *<A NAME="'nottybuiltin'"></A><B>'nottybuiltin'</B>* *<A NAME="'notbi'"></A><B>'notbi'</B>*
<A HREF="#'ttybuiltin'">'ttybuiltin'</A> <A HREF="#'tbi'">'tbi'</A> <A HREF="#boolean">boolean</A> (default on)
global
{not in Vi}
When on, the builtin termcaps are searched before the external ones.
When off the builtin termcaps are searched after the external ones.
When this option is changed, you should set the <A HREF="#'term'">'term'</A> option next for
the change to take effect, for example:
<B> :set notbi term=$TERM</B>
See also |<A HREF="term.html#termcap">termcap</A>|.
Rationale: The default for this option is "on", because the builtin
<A HREF="term.html#termcap">termcap</A> entries are generally better (many systems contain faulty
xterm entries...).
*<A NAME="'ttyfast'"></A><B>'ttyfast'</B>* *<A NAME="'tf'"></A><B>'tf'</B>* *<A NAME="'nottyfast'"></A><B>'nottyfast'</B>* *<A NAME="'notf'"></A><B>'notf'</B>*
<A HREF="#'ttyfast'">'ttyfast'</A> <A HREF="#'tf'">'tf'</A> <A HREF="#boolean">boolean</A> (default off, on when <A HREF="#'term'">'term'</A> is xterm, <A HREF="term.html#hpterm">hpterm</A>,
sun-cmd, screen, <A HREF="syntax.html#rxvt">rxvt</A>, dtterm or
iris-ansi; also on when running Vim in
a <A HREF="os_dos.html#DOS">DOS</A> console)
global
{not in Vi}
Indicates a fast <A HREF="terminal.html#terminal">terminal</A> connection. More characters will be sent to
the screen for redrawing, instead of using insert/delete line
commands. Improves smoothness of redrawing when there are multiple
<A HREF="windows.html#windows">windows</A> and the <A HREF="terminal.html#terminal">terminal</A> does not support a <A HREF="scroll.html#scrolling">scrolling</A> region.
Also enables the extra <A HREF="editing.html#writing">writing</A> of characters at the end of each screen
line for lines that wrap. This helps when using copy/paste with the
mouse in an xterm and other terminals.
*<A NAME="'ttymouse'"></A><B>'ttymouse'</B>* *<A NAME="'ttym'"></A><B>'ttym'</B>*
<A HREF="#'ttymouse'">'ttymouse'</A> <A HREF="#'ttym'">'ttym'</A> <A HREF="eval.html#string">string</A> (default depends on <A HREF="#'term'">'term'</A>)
global
{not in Vi}
{only in <A HREF="os_unix.html#Unix">Unix</A> and <A HREF="os_vms.html#VMS">VMS</A>, doesn't work in the <A HREF="gui.html#GUI">GUI</A>; not
available when compiled without YXXY+mouse|}
Name of the <A HREF="terminal.html#terminal">terminal</A> type for which mouse codes are to be recognized.
Currently these strings are valid:
*<A NAME="xterm-mouse"></A><B>xterm-mouse</B>*
xterm xterm-like mouse handling. The mouse generates
"<Esc>[Mscr", where "scr" is three bytes:
"<A HREF="change.html#s">s</A>" = button state
"<A HREF="change.html#c">c</A>" = column plus 33
"<A HREF="change.html#r">r</A>" = row plus 33
This only works up to 223 columns! See "dec",
"urxvt", and "sgr" for solutions.
xterm2 Works like "xterm", but with the xterm reporting the
mouse position while the mouse is dragged. This works
much faster and more precise. Your xterm must at
least at patchlevel 88 / XFree 3.3.3 for this to
work. See below for how Vim detects this
automatically.
*<A NAME="netterm-mouse"></A><B>netterm-mouse</B>*
netterm NetTerm mouse handling. The mouse generates
"<Esc>}r,c<CR>", where "r,c" are two decimal numbers
for the row and column.
*<A NAME="dec-mouse"></A><B>dec-mouse</B>*
dec DEC <A HREF="terminal.html#terminal">terminal</A> mouse handling. The mouse generates a
rather complex sequence, starting with "<Esc>[".
This is also available for an Xterm, if <A HREF="motion.html#it">it</A> was
configured with "--enable-dec-locator".
*<A NAME="jsbterm-mouse"></A><B>jsbterm-mouse</B>*
jsbterm JSB term mouse handling.
*<A NAME="pterm-mouse"></A><B>pterm-mouse</B>*
pterm <A HREF="os_qnx.html#QNX">QNX</A> pterm mouse handling.
*<A NAME="urxvt-mouse"></A><B>urxvt-mouse</B>*
urxvt Mouse handling for the urxvt (rxvt-unicode) <A HREF="terminal.html#terminal">terminal</A>.
The mouse works only if the <A HREF="terminal.html#terminal">terminal</A> supports this
encoding style, but <A HREF="motion.html#it">it</A> does not have 223 columns limit
unlike "xterm" or "xterm2".
*<A NAME="sgr-mouse"></A><B>sgr-mouse</B>*
sgr Mouse handling for the <A HREF="terminal.html#terminal">terminal</A> that emits SGR-styled
mouse reporting. The mouse works even in columns
beyond 223. This option is backward compatible with
"xterm2" because <A HREF="motion.html#it">it</A> can also decode "xterm2" style
mouse codes.
The mouse handling must be enabled at compile time |<A HREF="various.html#+mouse_xterm">+mouse_xterm</A>|
|<A HREF="various.html#+mouse_dec">+mouse_dec</A>| |<A HREF="various.html#+mouse_netterm">+mouse_netterm</A>| |<A HREF="various.html#+mouse_jsbterm">+mouse_jsbterm</A>| |<A HREF="various.html#+mouse_urxvt">+mouse_urxvt</A>|
|<A HREF="various.html#+mouse_sgr">+mouse_sgr</A>|.
Only "xterm"(2) is really recognized. NetTerm mouse codes are always
recognized, if enabled at compile time. DEC <A HREF="terminal.html#terminal">terminal</A> mouse codes
are recognized if enabled at compile time, and <A HREF="#'ttymouse'">'ttymouse'</A> is not
"xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
with them).
This option is automatically set to "xterm", when the <A HREF="#'term'">'term'</A> option is
set to a name that starts with "xterm", "mlterm", "screen", "tmux",
"st" (full match only), "st-" or "stterm", and <A HREF="#'ttymouse'">'ttymouse'</A> is not set
already.
Additionally, if vim is compiled with the |<A HREF="various.html#+termresponse">+termresponse</A>| feature and
|<A HREF="term.html#t_RV">t_RV</A>| is set to the <A HREF="intro.html#escape">escape</A> sequence to request the xterm version
number, more intelligent detection process runs.
The "xterm2" value will be set if the xterm version is reported to be
from 95 to 276. The "sgr" value will be set if the xterm version is
277 or higher and when Vim detects <A HREF="os_mac.html#Mac">Mac</A> Terminal.app or iTerm2.
If you <A HREF="diff.html#do">do</A> not want <A HREF="#'ttymouse'">'ttymouse'</A> to be set to "xterm2" or "sgr"
automatically, set <A HREF="term.html#t_RV">t_RV</A> to an empty <A HREF="eval.html#string">string</A>:
<B> :set t_RV=</B>
*<A NAME="'ttyscroll'"></A><B>'ttyscroll'</B>* *<A NAME="'tsl'"></A><B>'tsl'</B>*
<A HREF="#'ttyscroll'">'ttyscroll'</A> <A HREF="#'tsl'">'tsl'</A> number (default 999)
global
Maximum number of lines to scroll the screen. If there are more lines
to scroll the <A HREF="windows.html#window">window</A> is redrawn. For terminals where <A HREF="scroll.html#scrolling">scrolling</A> is
very slow and redrawing is not slow this can be set to a small number,
e.g., 3, to speed up displaying.
*<A NAME="'ttytype'"></A><B>'ttytype'</B>* *<A NAME="'tty'"></A><B>'tty'</B>*
<A HREF="#'ttytype'">'ttytype'</A> <A HREF="#'tty'">'tty'</A> <A HREF="eval.html#string">string</A> (default from $TERM)
global
Alias for <A HREF="#'term'">'term'</A>, see above.
*<A NAME="'undodir'"></A><B>'undodir'</B>* *<A NAME="'udir'"></A><B>'udir'</B>*
<A HREF="#'undodir'">'undodir'</A> <A HREF="#'udir'">'udir'</A> <A HREF="eval.html#string">string</A> (default "<A HREF="repeat.html#.">.</A>")
global
{not in Vi}
{only when compiled with the |<A HREF="various.html#+persistent_undo">+persistent_undo</A>| feature}
<A HREF="eval.html#List">List</A> of directory names for <A HREF="undo.html#undo">undo</A> files, separated with commas.
See |<A HREF="#'backupdir'">'backupdir'</A>| for details of the format.
"<A HREF="repeat.html#.">.</A>" means using the directory of the file. The <A HREF="undo.html#undo">undo</A> file name for
"file.txt" is ".file.txt.un~".
For other directories the file name is the full path of the edited
file, with path separators replaced with "<A HREF="motion.html#%">%</A>".
When <A HREF="editing.html#writing">writing</A>: The first directory that exists is used. "<A HREF="repeat.html#.">.</A>" always
works, no directories after "<A HREF="repeat.html#.">.</A>" will be used for <A HREF="editing.html#writing">writing</A>.
When reading all entries are tried to find an <A HREF="undo.html#undo">undo</A> file. The first
<A HREF="undo.html#undo">undo</A> file that exists is used. When <A HREF="motion.html#it">it</A> cannot be read an error is
given, no further entry is used.
See |<A HREF="undo.html#undo-persistence">undo-persistence</A>|.
*<A NAME="'undofile'"></A><B>'undofile'</B>* *<A NAME="'noundofile'"></A><B>'noundofile'</B>* *<A NAME="'udf'"></A><B>'udf'</B>* *<A NAME="'noudf'"></A><B>'noudf'</B>*
<A HREF="#'undofile'">'undofile'</A> <A HREF="#'udf'">'udf'</A> <A HREF="#boolean">boolean</A> (default off)
local to buffer
{not in Vi}
{only when compiled with the |<A HREF="various.html#+persistent_undo">+persistent_undo</A>| feature}
When on, Vim automatically saves <A HREF="undo.html#undo">undo</A> <A HREF="cmdline.html#history">history</A> to an <A HREF="undo.html#undo">undo</A> file when
<A HREF="editing.html#writing">writing</A> a buffer to a file, and restores <A HREF="undo.html#undo">undo</A> <A HREF="cmdline.html#history">history</A> from the same
file on buffer read.
The directory where the <A HREF="undo.html#undo">undo</A> file is stored is specified by <A HREF="#'undodir'">'undodir'</A>.
For more information about this feature see |<A HREF="undo.html#undo-persistence">undo-persistence</A>|.
The <A HREF="undo.html#undo">undo</A> file is not read when <A HREF="#'undoreload'">'undoreload'</A> causes the buffer from
before a <A HREF="editing.html#reload">reload</A> to be saved for <A HREF="undo.html#undo">undo</A>.
When <A HREF="#'undofile'">'undofile'</A> is turned off the <A HREF="undo.html#undo">undo</A> file is NOT deleted.
NOTE: This option is reset when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'undolevels'"></A><B>'undolevels'</B>* *<A NAME="'ul'"></A><B>'ul'</B>*
<A HREF="#'undolevels'">'undolevels'</A> <A HREF="#'ul'">'ul'</A> number (default 100, 1000 for <A HREF="os_unix.html#Unix">Unix</A>, <A HREF="os_vms.html#VMS">VMS</A>,
<A HREF="os_win32.html#Win32">Win32</A> and <A HREF="os_os2.html#OS/2">OS/2</A>)
global or local to buffer |<A HREF="#global-local">global-local</A>|
{not in Vi}
Maximum number of changes that can be undone. Since <A HREF="undo.html#undo">undo</A> information
is kept in memory, higher numbers will cause more memory to be used
(nevertheless, a single change can use an unlimited amount of memory).
Set to 0 for <A HREF="intro.html#Vi">Vi</A> compatibility: One level of <A HREF="undo.html#undo">undo</A> and "<A HREF="undo.html#u">u</A>" undoes
itself:
<B> set ul=0</B>
But you can also get <A HREF="intro.html#Vi">Vi</A> compatibility by including the '<A HREF="undo.html#u">u</A>' flag in
<A HREF="#'cpoptions'">'cpoptions'</A>, and still be able to use <A HREF="undo.html#CTRL-R">CTRL-R</A> to repeat <A HREF="undo.html#undo">undo</A>.
Also see |<A HREF="undo.html#undo-two-ways">undo-two-ways</A>|.
Set to -1 for no <A HREF="undo.html#undo">undo</A> at all. You might want to <A HREF="diff.html#do">do</A> this only for the
current buffer:
<B> setlocal ul=-1</B>
This helps when you run out of memory for a single change.
The local value is set to -123456 when the global value is to be used.
Also see |<A HREF="undo.html#clear-undo">clear-undo</A>|.
*<A NAME="'undoreload'"></A><B>'undoreload'</B>* *<A NAME="'ur'"></A><B>'ur'</B>*
<A HREF="#'undoreload'">'undoreload'</A> <A HREF="#'ur'">'ur'</A> number (default 10000)
global
{not in Vi}
Save the whole buffer for <A HREF="undo.html#undo">undo</A> when reloading <A HREF="motion.html#it">it</A>. This applies to the
":e!" command and reloading for when the buffer changed outside of
Vim. |<A HREF="autocmd.html#FileChangedShell">FileChangedShell</A>|
The save only happens when this option is negative or when the number
of lines is smaller than the value of this option.
Set this option to zero to disable <A HREF="undo.html#undo">undo</A> for a <A HREF="editing.html#reload">reload</A>.
When saving <A HREF="undo.html#undo">undo</A> for a <A HREF="editing.html#reload">reload</A>, any <A HREF="undo.html#undo">undo</A> file is not read.
Note that this causes the whole buffer to be stored in memory. Set
this option to a lower value if you run out of memory.
*<A NAME="'updatecount'"></A><B>'updatecount'</B>* *<A NAME="'uc'"></A><B>'uc'</B>*
<A HREF="#'updatecount'">'updatecount'</A> <A HREF="#'uc'">'uc'</A> number (default: 200)
global
{not in Vi}
After typing this many characters the swap file will be written to
disk. When zero, no swap file will be created at all (see chapter on
recovery |<A HREF="recover.html#crash-recovery">crash-recovery</A>|). <A HREF="#'updatecount'">'updatecount'</A> is set to zero by starting
Vim with the "<A HREF="starting.html#-n">-n</A>" option, see |<A HREF="starting.html#startup">startup</A>|. When editing in readonly
mode this option will be initialized to 10000.
The swapfile can be disabled per buffer with |<A HREF="#'swapfile'">'swapfile'</A>|.
When <A HREF="#'updatecount'">'updatecount'</A> is set from zero to non-zero, swap files are
created for all <A HREF="windows.html#buffers">buffers</A> that have <A HREF="#'swapfile'">'swapfile'</A> set. When <A HREF="#'updatecount'">'updatecount'</A>
is set to zero, existing swap files are not deleted.
Also see |<A HREF="#'swapsync'">'swapsync'</A>|.
This option has no meaning in <A HREF="windows.html#buffers">buffers</A> where |<A HREF="#'buftype'">'buftype'</A>| is "nofile"
or "nowrite".
*<A NAME="'updatetime'"></A><B>'updatetime'</B>* *<A NAME="'ut'"></A><B>'ut'</B>*
<A HREF="#'updatetime'">'updatetime'</A> <A HREF="#'ut'">'ut'</A> number (default 4000)
global
{not in Vi}
If this many milliseconds nothing is typed the swap file will be
written to disk (see |<A HREF="recover.html#crash-recovery">crash-recovery</A>|). Also used for the
|<A HREF="autocmd.html#CursorHold">CursorHold</A>| <A HREF="autocmd.html#autocommand">autocommand</A> event.
*<A NAME="'verbose'"></A><B>'verbose'</B>* *<A NAME="'vbs'"></A><B>'vbs'</B>*
<A HREF="#'verbose'">'verbose'</A> <A HREF="#'vbs'">'vbs'</A> number (default 0)
global
{not in <A HREF="intro.html#Vi">Vi</A>, although some versions have a <A HREF="#boolean">boolean</A>
<A HREF="starting.html#verbose">verbose</A> option}
When bigger than zero, Vim will give <A HREF="message.html#messages">messages</A> about what <A HREF="motion.html#it">it</A> is doing.
Currently, these <A HREF="message.html#messages">messages</A> are given:
>= 1 When the <A HREF="starting.html#viminfo">viminfo</A> file is read or written.
>= 2 When a file is ":source"'ed.
>= 5 Every searched <A HREF="tagsrch.html#tags">tags</A> file and include file.
>= 8 Files for which a group of autocommands is executed.
>= 9 Every executed <A HREF="autocmd.html#autocommand">autocommand</A>.
>= 12 Every executed function.
>= 13 When an exception is thrown, caught, finished, or discarded.
>= 14 Anything pending in a "<A HREF="eval.html#:finally">:finally</A>" clause.
>= 15 Every executed <A HREF="intro.html#Ex">Ex</A> command (truncated at 200 characters).
This option can also be set with the "-V" argument. See |<A HREF="starting.html#-V">-V</A>|.
This option is also set by the |<A HREF="various.html#:verbose">:verbose</A>| command.
When the <A HREF="#'verbosefile'">'verbosefile'</A> option is set then the <A HREF="starting.html#verbose">verbose</A> <A HREF="message.html#messages">messages</A> are not
displayed.
*<A NAME="'verbosefile'"></A><B>'verbosefile'</B>* *<A NAME="'vfile'"></A><B>'vfile'</B>*
<A HREF="#'verbosefile'">'verbosefile'</A> <A HREF="#'vfile'">'vfile'</A> <A HREF="eval.html#string">string</A> (default empty)
global
{not in Vi}
When not empty all <A HREF="message.html#messages">messages</A> are written in a file with this name.
When the file exists <A HREF="message.html#messages">messages</A> are appended.
Writing to the file ends when Vim exits or when <A HREF="#'verbosefile'">'verbosefile'</A> is made
empty. Writes are buffered, thus may not show up for some time.
Setting <A HREF="#'verbosefile'">'verbosefile'</A> to a new value is like making <A HREF="motion.html#it">it</A> empty first.
The difference with |<A HREF="various.html#:redir">:redir</A>| is that <A HREF="starting.html#verbose">verbose</A> <A HREF="message.html#messages">messages</A> are not
displayed when <A HREF="#'verbosefile'">'verbosefile'</A> is set.
*<A NAME="'viewdir'"></A><B>'viewdir'</B>* *<A NAME="'vdir'"></A><B>'vdir'</B>*
<A HREF="#'viewdir'">'viewdir'</A> <A HREF="#'vdir'">'vdir'</A> <A HREF="eval.html#string">string</A> (default for <A HREF="os_amiga.html#Amiga">Amiga</A>, <A HREF="os_msdos.html#MS-DOS">MS-DOS</A>, <A HREF="os_os2.html#OS/2">OS/2</A> and <A HREF="os_win32.html#Win32">Win32</A>:
"$VIM/vimfiles/view",
for <A HREF="os_unix.html#Unix">Unix</A>: "~/.vim/view",
for <A HREF="os_mac.html#Macintosh">Macintosh</A>: "$VIM:vimfiles:view"
for <A HREF="os_vms.html#VMS">VMS</A>: "sys$login:vimfiles/view"
for RiscOS: "Choices:vimfiles/view")
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+mksession">+mksession</A>|
feature}
Name of the directory where to store files for |<A HREF="starting.html#:mkview">:mkview</A>|.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'viewoptions'"></A><B>'viewoptions'</B>* *<A NAME="'vop'"></A><B>'vop'</B>*
<A HREF="#'viewoptions'">'viewoptions'</A> <A HREF="#'vop'">'vop'</A> <A HREF="eval.html#string">string</A> (default: "folds,options,cursor,curdir")
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+mksession">+mksession</A>|
feature}
Changes the effect of the |<A HREF="starting.html#:mkview">:mkview</A>| command. It is a comma separated
<A HREF="eval.html#list">list</A> of words. Each <A HREF="motion.html#word">word</A> enables saving and restoring something:
<B><FONT COLOR="PURPLE"> word save and restore </FONT></B>
cursor cursor position in file and in <A HREF="windows.html#window">window</A>
<A HREF="fold.html#folds">folds</A> manually created <A HREF="fold.html#folds">folds</A>, opened/closed <A HREF="fold.html#folds">folds</A> and local
fold <A HREF="#options">options</A>
<A HREF="#options">options</A> <A HREF="#options">options</A> and mappings local to a <A HREF="windows.html#window">window</A> or buffer (not
global values for local <A HREF="#options">options</A>)
localoptions same <A HREF="motion.html#as">as</A> "<A HREF="#options">options</A>"
slash backslashes in file names replaced with forward
slashes
<A HREF="os_unix.html#unix">unix</A> with <A HREF="os_unix.html#Unix">Unix</A> end-of-line format (single <NL>), even when
on Windows or <A HREF="os_dos.html#DOS">DOS</A>
curdir the window-local directory, if set with `:lcd`
"slash" and "<A HREF="os_unix.html#unix">unix</A>" are useful on Windows when sharing <A HREF="starting.html#view">view</A> files
with <A HREF="os_unix.html#Unix">Unix</A>. The <A HREF="os_unix.html#Unix">Unix</A> version of Vim cannot source <A HREF="os_dos.html#dos">dos</A> format scripts,
but the Windows version of Vim can source <A HREF="os_unix.html#unix">unix</A> format scripts.
*<A NAME="'viminfo'"></A><B>'viminfo'</B>* *<A NAME="'vi'"></A><B>'vi'</B>* *<A NAME="E526"></A><B>E526</B>* *<A NAME="E527"></A><B>E527</B>* *<A NAME="E528"></A><B>E528</B>*
<A HREF="#'viminfo'">'viminfo'</A> <A HREF="#'vi'">'vi'</A> <A HREF="eval.html#string">string</A> (Vi default: "", Vim default for <A HREF="os_msdos.html#MS-DOS">MS-DOS</A>,
Windows and <A HREF="os_os2.html#OS/2">OS/2</A>: '100,<50,s10,h,rA:,rB:,
for <A HREF="os_amiga.html#Amiga">Amiga</A>: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
for others: '100,<50,s10,h)
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+viminfo">+viminfo</A>|
feature}
When non-empty, the <A HREF="starting.html#viminfo">viminfo</A> file is read upon <A HREF="starting.html#startup">startup</A> and written
when <A HREF="starting.html#exiting">exiting</A> Vim (see |<A HREF="starting.html#viminfo-file">viminfo-file</A>|). Except when <A HREF="#'viminfofile'">'viminfofile'</A> is
"NONE".
The <A HREF="eval.html#string">string</A> should be a comma separated <A HREF="eval.html#list">list</A> of parameters, each
consisting of a single character identifying the particular parameter,
followed by a number or <A HREF="eval.html#string">string</A> which specifies the value of that
parameter. If a particular character is left out, then the default
value is used for that parameter. The following is a <A HREF="eval.html#list">list</A> of the
identifying characters and the effect of their value.
<B><FONT COLOR="PURPLE"> CHAR VALUE </FONT></B>
*<A NAME="viminfo-!"></A><B>viminfo-!</B>*
! When included, save and restore global <A HREF="eval.html#variables">variables</A> that start
with an <A HREF="change.html#uppercase">uppercase</A> <A HREF="print.html#letter">letter</A>, and don't contain a <A HREF="change.html#lowercase">lowercase</A>
<A HREF="print.html#letter">letter</A>. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
and "_K_L_M" are not. Nested <A HREF="eval.html#List">List</A> and Dict items may not be
read back correctly, you end up with an empty item.
*<A NAME="viminfo-quote"></A><B>viminfo-quote</B>*
" Maximum number of lines saved for each <A HREF="sponsor.html#register">register</A>. Old name of
the '<A HREF="change.html#<"><</A>' item, with the disadvantage that you need to put a
<A HREF="intro.html#backslash">backslash</A> before the "<A HREF="motion.html#,">,</A> otherwise <A HREF="motion.html#it">it</A> will be recognized <A HREF="motion.html#as">as</A> the
start of a comment!
*<A NAME="viminfo-%"></A><B>viminfo-%</B>*
<A HREF="motion.html#%">%</A> When included, save and restore the buffer <A HREF="eval.html#list">list</A>. If Vim is
started with a file name argument, the buffer <A HREF="eval.html#list">list</A> is not
restored. If Vim is started without a file name argument, the
buffer <A HREF="eval.html#list">list</A> is restored from the <A HREF="starting.html#viminfo">viminfo</A> file. <A HREF="quickfix.html#Quickfix">Quickfix</A>
('buftype'), unlisted ('buflisted'), unnamed and <A HREF="windows.html#buffers">buffers</A> on
removable media (|<A HREF="#viminfo-r">viminfo-r</A>|) are not saved.
When followed by a number, the number specifies the maximum
number of <A HREF="windows.html#buffers">buffers</A> that are stored. Without a number all
<A HREF="windows.html#buffers">buffers</A> are stored.
*<A NAME="viminfo-'"></A><B>viminfo-'</B>*
'' Maximum number of previously edited files for which the marks
are remembered. This parameter must always be included when
<A HREF="#'viminfo'">'viminfo'</A> is non-empty.
Including this item also means that the |<A HREF="motion.html#jumplist">jumplist</A>| and the
|<A HREF="motion.html#changelist">changelist</A>| are stored in the <A HREF="starting.html#viminfo">viminfo</A> file.
*<A NAME="viminfo-/"></A><B>viminfo-/</B>*
/ Maximum number of items in the search <A HREF="pattern.html#pattern">pattern</A> <A HREF="cmdline.html#history">history</A> to be
saved. If non-zero, then the previous search and substitute
patterns are also saved. When not included, the value of
<A HREF="#'history'">'history'</A> is used.
*<A NAME="viminfo-:"></A><B>viminfo-:</B>*
: Maximum number of items in the command-line <A HREF="cmdline.html#history">history</A> to be
saved. When not included, the value of <A HREF="#'history'">'history'</A> is used.
*<A NAME="viminfo-<"></A><B>viminfo-<</B>*
<A HREF="change.html#<"><</A> Maximum number of lines saved for each <A HREF="sponsor.html#register">register</A>. If zero then
<A HREF="change.html#registers">registers</A> are not saved. When not included, all lines are
saved. '"'' is the old name for this item.
Also see the '<A HREF="change.html#s">s</A>' item below: limit specified in Kbyte.
*<A NAME="viminfo-@"></A><B>viminfo-@</B>*
@ Maximum number of items in the input-line <A HREF="cmdline.html#history">history</A> to be
saved. When not included, the value of <A HREF="#'history'">'history'</A> is used.
*<A NAME="viminfo-c"></A><B>viminfo-c</B>*
<A HREF="change.html#c">c</A> When included, convert the text in the <A HREF="starting.html#viminfo">viminfo</A> file from the
<A HREF="#'encoding'">'encoding'</A> used when <A HREF="editing.html#writing">writing</A> the file to the current
<A HREF="#'encoding'">'encoding'</A>. See |<A HREF="starting.html#viminfo-encoding">viminfo-encoding</A>|.
*<A NAME="viminfo-f"></A><B>viminfo-f</B>*
<A HREF="motion.html#f">f</A> Whether file marks need to be stored. If zero, file marks ('0
to '9, <A HREF="motion.html#'A">'A</A> to 'Z) are not stored. When not present or when
non-zero, they are all stored. <A HREF="motion.html#'0">'0</A> is used for the current
cursor position (when <A HREF="starting.html#exiting">exiting</A> or when doing ":wviminfo").
*<A NAME="viminfo-h"></A><B>viminfo-h</B>*
<A HREF="motion.html#h">h</A> Disable the effect of <A HREF="#'hlsearch'">'hlsearch'</A> when loading the <A HREF="starting.html#viminfo">viminfo</A>
file. When not included, <A HREF="motion.html#it">it</A> depends on whether "<A HREF="pattern.html#:nohlsearch">:nohlsearch</A>"
has been used since the last search command.
*<A NAME="viminfo-n"></A><B>viminfo-n</B>*
<A HREF="pattern.html#n">n</A> Name of the <A HREF="starting.html#viminfo">viminfo</A> file. The name must immediately follow
the '<A HREF="pattern.html#n">n</A>'. Must be at the end of the option! If the
<A HREF="#'viminfofile'">'viminfofile'</A> option is set, that file name overrides the one
given here with <A HREF="#'viminfo'">'viminfo'</A>. Environment <A HREF="eval.html#variables">variables</A> are
expanded when opening the file, not when setting the option.
*<A NAME="viminfo-r"></A><B>viminfo-r</B>*
<A HREF="change.html#r">r</A> Removable media. The argument is a <A HREF="eval.html#string">string</A> (up to the next
','). This parameter can be given several times. Each
specifies the start of a path for which no marks will be
stored. This is to avoid removable media. For <A HREF="os_msdos.html#MS-DOS">MS-DOS</A> you
could use "ra:,rb:", for <A HREF="os_amiga.html#Amiga">Amiga</A> "rdf0:,rdf1:,rdf2:". You can
also use <A HREF="motion.html#it">it</A> for temp files, e.g., for <A HREF="os_unix.html#Unix">Unix</A>: "r/tmp". Case is
ignored. Maximum length of each '<A HREF="change.html#r">r</A>' argument is 50
characters.
*<A NAME="viminfo-s"></A><B>viminfo-s</B>*
<A HREF="change.html#s">s</A> Maximum size of an item in Kbyte. If zero then <A HREF="change.html#registers">registers</A> are
not saved. Currently only applies to <A HREF="change.html#registers">registers</A>. The default
"s10" will exclude <A HREF="change.html#registers">registers</A> with more than 10 Kbyte of text.
Also see the '<A HREF="change.html#<"><</A>' item above: line <A HREF="intro.html#count">count</A> limit.
Example:
<B> :set viminfo='50,<1000,s100,:0,n~/vim/viminfo</B>
'50 Marks will be remembered for the last 50 files you
edited.
<1000 <A HREF="quickref.html#Contents">Contents</A> of <A HREF="change.html#registers">registers</A> (up to 1000 lines each) will be
remembered.
s100 Registers with more than 100 Kbyte text are skipped.
:0 <A HREF="cmdline.html#Command-line">Command-line</A> <A HREF="cmdline.html#history">history</A> will not be saved.
n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
no / Since '<A HREF="pattern.html#/">/</A>' is not specified, the default will be used,
that is, save all of the search <A HREF="cmdline.html#history">history</A>, and also the
previous search and substitute patterns.
no <A HREF="motion.html#%">%</A> The buffer <A HREF="eval.html#list">list</A> will not be saved nor read back.
no <A HREF="motion.html#h">h</A> <A HREF="#'hlsearch'">'hlsearch'</A> highlighting will be restored.
When setting <A HREF="#'viminfo'">'viminfo'</A> from an empty value you can use |<A HREF="starting.html#:rviminfo">:rviminfo</A>| to
load the contents of the file, this is not done automatically.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
NOTE: This option is set to the Vim default value when <A HREF="#'compatible'">'compatible'</A>
is reset.
*<A NAME="'viminfofile'"></A><B>'viminfofile'</B>* *<A NAME="'vif'"></A><B>'vif'</B>*
<A HREF="#'viminfofile'">'viminfofile'</A> <A HREF="#'vif'">'vif'</A> <A HREF="eval.html#string">string</A> (default: "")
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+viminfo">+viminfo</A>|
feature}
When non-empty, overrides the file name used for <A HREF="starting.html#viminfo">viminfo</A>.
When equal to "NONE" no <A HREF="starting.html#viminfo">viminfo</A> file will be read or written.
This option can be set with the |<A HREF="starting.html#-i">-i</A>| command line flag. The |<A HREF="starting.html#--clean">--clean</A>|
command line flag sets <A HREF="motion.html#it">it</A> to "NONE".
*<A NAME="'virtualedit'"></A><B>'virtualedit'</B>* *<A NAME="'ve'"></A><B>'ve'</B>*
<A HREF="#'virtualedit'">'virtualedit'</A> <A HREF="#'ve'">'ve'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not in Vi}
{not available when compiled without the
|<A HREF="various.html#+virtualedit">+virtualedit</A>| feature}
A comma separated <A HREF="eval.html#list">list</A> of these words:
block Allow virtual editing in <A HREF="visual.html#Visual">Visual</A> block mode.
insert Allow virtual editing in <A HREF="insert.html#Insert">Insert</A> mode.
all Allow virtual editing in all modes.
onemore Allow the cursor to move just past the end of the line
Virtual editing means that the cursor can be positioned where there is
no actual character. This can be halfway into a <A HREF="intro.html#tab">tab</A> or beyond the end
of the line. Useful for selecting a rectangle in <A HREF="visual.html#Visual">Visual</A> mode and
editing a table.
"onemore" is not the same, <A HREF="motion.html#it">it</A> will only allow moving the cursor just
after the last character of the line. This makes some commands more
consistent. Previously the cursor was always past the end of the line
if the line was empty. But <A HREF="motion.html#it">it</A> is far from <A HREF="intro.html#Vi">Vi</A> compatible. It may also
break some plugins or Vim scripts. For example because |<A HREF="motion.html#l">l</A>| can move
the cursor after the last character. Use with care!
Using the `$` command will move to the last character in the line, not
past <A HREF="motion.html#it">it</A>. This may actually move the cursor to the left!
The `g$` command will move to the end of the screen line.
It doesn't make sense to combine "all" with "onemore", but you will
not get a warning for <A HREF="motion.html#it">it</A>.
NOTE: This option is set to "" when <A HREF="#'compatible'">'compatible'</A> is set.
*<A NAME="'visualbell'"></A><B>'visualbell'</B>* *<A NAME="'vb'"></A><B>'vb'</B>* *<A NAME="'novisualbell'"></A><B>'novisualbell'</B>* *<A NAME="'novb'"></A><B>'novb'</B>* *<A NAME="beep"></A><B>beep</B>*
<A HREF="#'visualbell'">'visualbell'</A> <A HREF="#'vb'">'vb'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
Use a visual bell instead of beeping. The <A HREF="terminal.html#terminal">terminal</A> code to display the
visual bell is given with <A HREF="term.html#'t_vb'">'t_vb'</A>. When no beep or flash is wanted,
use:
<B> :set vb t_vb=</B>
If you want a short flash, you can use this on many terminals:
<B> :set vb t_vb=[?5h$<100>[?5l</B>
Here $<100> specifies the time, you can use a smaller or bigger value
to get a shorter or longer flash.
Note: Vim will limit the bell to once per half a second. This avoids
having to wait for the flashing to finish when there are lots of
bells, e.g. on key repeat. This also happens without <A HREF="#'visualbell'">'visualbell'</A>
set.
In the <A HREF="gui.html#GUI">GUI</A>, <A HREF="term.html#'t_vb'">'t_vb'</A> defaults to "<Esc>|f", which inverts the display
for 20 msec. If you want to use a different time, use "<Esc>|40f",
where 40 is the time in msec.
Note: When the <A HREF="gui.html#GUI">GUI</A> starts, <A HREF="term.html#'t_vb'">'t_vb'</A> is reset to its default value. You
might want to set <A HREF="motion.html#it">it</A> again in your |<A HREF="gui.html#gvimrc">gvimrc</A>|.
Does not work on the <A HREF="os_amiga.html#Amiga">Amiga</A>, you always get a screen flash.
Also see <A HREF="#'errorbells'">'errorbells'</A>.
*<A NAME="'warn'"></A><B>'warn'</B>* *<A NAME="'nowarn'"></A><B>'nowarn'</B>*
<A HREF="#'warn'">'warn'</A> <A HREF="#boolean">boolean</A> (default on)
global
Give a warning message when a shell command is used while the buffer
has been changed.
*<A NAME="'weirdinvert'"></A><B>'weirdinvert'</B>* *<A NAME="'wiv'"></A><B>'wiv'</B>* *<A NAME="'noweirdinvert'"></A><B>'noweirdinvert'</B>* *<A NAME="'nowiv'"></A><B>'nowiv'</B>*
<A HREF="#'weirdinvert'">'weirdinvert'</A> <A HREF="#'wiv'">'wiv'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
This option has the same effect <A HREF="motion.html#as">as</A> the <A HREF="term.html#'t_xs'">'t_xs'</A> <A HREF="terminal.html#terminal">terminal</A> option.
It is provided for backwards compatibility with version 4.x.
Setting <A HREF="#'weirdinvert'">'weirdinvert'</A> has the effect of making <A HREF="term.html#'t_xs'">'t_xs'</A> non-empty, and
vice versa. Has no effect when the <A HREF="gui.html#GUI">GUI</A> is running.
*<A NAME="'whichwrap'"></A><B>'whichwrap'</B>* *<A NAME="'ww'"></A><B>'ww'</B>*
<A HREF="#'whichwrap'">'whichwrap'</A> <A HREF="#'ww'">'ww'</A> <A HREF="eval.html#string">string</A> (Vim default: "b,s", <A HREF="intro.html#Vi">Vi</A> default: "")
global
{not in Vi}
Allow specified keys that move the cursor left/right to move to the
previous/next line when the cursor is on the first/last character in
the line. Concatenate characters to allow this for these keys:
<B><FONT COLOR="PURPLE"> char key mode </FONT></B>
<A HREF="motion.html#b">b</A> <A HREF="motion.html#<BS>"><BS></A> <A HREF="intro.html#Normal">Normal</A> and <A HREF="visual.html#Visual">Visual</A>
<A HREF="change.html#s">s</A> <A HREF="motion.html#<Space>"><Space></A> <A HREF="intro.html#Normal">Normal</A> and <A HREF="visual.html#Visual">Visual</A>
<A HREF="motion.html#h">h</A> "<A HREF="motion.html#h">h</A>" <A HREF="intro.html#Normal">Normal</A> and <A HREF="visual.html#Visual">Visual</A> (not recommended)
<A HREF="motion.html#l">l</A> "<A HREF="motion.html#l">l</A>" <A HREF="intro.html#Normal">Normal</A> and <A HREF="visual.html#Visual">Visual</A> (not recommended)
<A HREF="change.html#<"><</A> <A HREF="motion.html#<Left>"><Left></A> <A HREF="intro.html#Normal">Normal</A> and <A HREF="visual.html#Visual">Visual</A>
<A HREF="change.html#>">></A> <A HREF="motion.html#<Right>"><Right></A> <A HREF="intro.html#Normal">Normal</A> and <A HREF="visual.html#Visual">Visual</A>
~ "<A HREF="change.html#~">~</A>" <A HREF="intro.html#Normal">Normal</A>
[ <A HREF="motion.html#<Left>"><Left></A> <A HREF="insert.html#Insert">Insert</A> and <A HREF="insert.html#Replace">Replace</A>
] <A HREF="motion.html#<Right>"><Right></A> <A HREF="insert.html#Insert">Insert</A> and <A HREF="insert.html#Replace">Replace</A>
For example:
<B> :set ww=<,>,[,]</B>
allows wrap only when cursor keys are used.
When the <A HREF="intro.html#movement">movement</A> keys are used in combination with a delete or change
<A HREF="motion.html#operator">operator</A>, the <A HREF="intro.html#<EOL>"><EOL></A> also counts for a character. This makes "3h"
different from "3dh" when the cursor crosses the end of a line. This
is also true for "<A HREF="change.html#x">x</A>" and "<A HREF="change.html#X">X</A>", because they <A HREF="diff.html#do">do</A> the same <A HREF="motion.html#as">as</A> "<A HREF="change.html#dl">dl</A>" and
"<A HREF="change.html#dh">dh</A>". If you use this, you may also want to use the <A HREF="map.html#mapping">mapping</A>
"<A HREF="map.html#:map">:map</A> <A HREF="motion.html#<BS>"><BS></A> X" to make backspace delete the character in front of the
cursor.
When '<A HREF="motion.html#l">l</A>' is included and <A HREF="motion.html#it">it</A> is used after an <A HREF="motion.html#operator">operator</A> at the end of a
line then <A HREF="motion.html#it">it</A> will not move to the next line. This makes "<A HREF="change.html#dl">dl</A>", "cl",
"yl" etc. work normally.
NOTE: This option is set to the <A HREF="intro.html#Vi">Vi</A> default value when <A HREF="#'compatible'">'compatible'</A> is
set and to the Vim default value when <A HREF="#'compatible'">'compatible'</A> is reset.
*<A NAME="'wildchar'"></A><B>'wildchar'</B>* *<A NAME="'wc'"></A><B>'wc'</B>*
<A HREF="#'wildchar'">'wildchar'</A> <A HREF="#'wc'">'wc'</A> number (Vim default: <A HREF="motion.html#<Tab>"><Tab></A>, <A HREF="intro.html#Vi">Vi</A> default: <A HREF="scroll.html#CTRL-E">CTRL-E</A>)
global
{not in Vi}
Character you have to type to start <A HREF="editing.html#wildcard">wildcard</A> expansion in the
command-line, <A HREF="motion.html#as">as</A> specified with <A HREF="#'wildmode'">'wildmode'</A>.
More info here: |<A HREF="cmdline.html#cmdline-completion">cmdline-completion</A>|.
The character is not recognized when used inside a <A HREF="map.html#macro">macro</A>. See
<A HREF="#'wildcharm'">'wildcharm'</A> for that.
Although <A HREF="#'wc'">'wc'</A> is a number option, you can set <A HREF="motion.html#it">it</A> to a special key:
<B> :set wc=<Esc></B>
NOTE: This option is set to the <A HREF="intro.html#Vi">Vi</A> default value when <A HREF="#'compatible'">'compatible'</A> is
set and to the Vim default value when <A HREF="#'compatible'">'compatible'</A> is reset.
*<A NAME="'wildcharm'"></A><B>'wildcharm'</B>* *<A NAME="'wcm'"></A><B>'wcm'</B>*
<A HREF="#'wildcharm'">'wildcharm'</A> <A HREF="#'wcm'">'wcm'</A> number (default: none (0))
global
{not in Vi}
<A HREF="#'wildcharm'">'wildcharm'</A> works exactly like <A HREF="#'wildchar'">'wildchar'</A>, except that <A HREF="motion.html#it">it</A> is
recognized when used inside a <A HREF="map.html#macro">macro</A>. You can find "spare" command-line
keys suitable for this option by looking at |<A HREF="index.html#ex-edit-index">ex-edit-index</A>|. Normally
you'll never actually type <A HREF="#'wildcharm'">'wildcharm'</A>, just use <A HREF="motion.html#it">it</A> in mappings that
automatically invoke completion mode, e.g.:
<B> :set wcm=<C-Z></B>
<B> :cnoremap ss so $vim/sessions/*.vim<C-Z></B>
Then after typing :ss you can use <A HREF="motion.html#CTRL-P">CTRL-P</A> <A HREF="change.html#&">&</A> <A HREF="motion.html#CTRL-N">CTRL-N</A>.
*<A NAME="'wildignore'"></A><B>'wildignore'</B>* *<A NAME="'wig'"></A><B>'wig'</B>*
<A HREF="#'wildignore'">'wildignore'</A> <A HREF="#'wig'">'wig'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+wildignore">+wildignore</A>|
feature}
A <A HREF="eval.html#list">list</A> of file patterns. A file that matches with one of these
patterns is ignored when expanding |<A HREF="editing.html#wildcards">wildcards</A>|, completing file or
directory names, and influences the result of |<A HREF="eval.html#expand()">expand()</A>|, |<A HREF="eval.html#glob()">glob()</A>| and
|<A HREF="eval.html#globpath()">globpath()</A>| unless a flag is passed to disable this.
The pattern is used like with |<A HREF="autocmd.html#:autocmd">:autocmd</A>|, see |<A HREF="autocmd.html#autocmd-patterns">autocmd-patterns</A>|.
Also see <A HREF="#'suffixes'">'suffixes'</A>.
Example:
<B> :set wildignore=*.o,*.obj</B>
The use of |<A HREF="#:set+=">:set+=</A>| and |<A HREF="#:set-=">:set-=</A>| is preferred when adding or removing
a <A HREF="pattern.html#pattern">pattern</A> from the <A HREF="eval.html#list">list</A>. This avoids problems when a future version
uses another default.
*<A NAME="'wildignorecase'"></A><B>'wildignorecase'</B>* *<A NAME="'wic'"></A><B>'wic'</B>* *<A NAME="'nowildignorecase'"></A><B>'nowildignorecase'</B>* *<A NAME="'nowic'"></A><B>'nowic'</B>*
<A HREF="#'wildignorecase'">'wildignorecase'</A> <A HREF="#'wic'">'wic'</A> <A HREF="#boolean">boolean</A> (default off)
global
{not in Vi}
When set <A HREF="change.html#case">case</A> is ignored when completing file names and directories.
Has no effect when <A HREF="#'fileignorecase'">'fileignorecase'</A> is set.
Does not apply when the shell is used to expand <A HREF="editing.html#wildcards">wildcards</A>, which
happens when there are special characters.
*<A NAME="'wildmenu'"></A><B>'wildmenu'</B>* *<A NAME="'wmnu'"></A><B>'wmnu'</B>* *<A NAME="'nowildmenu'"></A><B>'nowildmenu'</B>* *<A NAME="'nowmnu'"></A><B>'nowmnu'</B>*
<A HREF="#'wildmenu'">'wildmenu'</A> <A HREF="#'wmnu'">'wmnu'</A> <A HREF="#boolean">boolean</A> (default off, set in |<A HREF="defaults.html">defaults.vim</A>|)
global
{not in Vi}
{not available if compiled without the |<A HREF="various.html#+wildmenu">+wildmenu</A>|
feature}
When <A HREF="#'wildmenu'">'wildmenu'</A> is on, command-line completion operates in an enhanced
mode. On pressing <A HREF="#'wildchar'">'wildchar'</A> (usually <A HREF="motion.html#<Tab>"><Tab></A>) to invoke completion,
the possible matches are shown just above the command line, with the
first match highlighted (overwriting the status line, if there is
one). Keys that show the previous/next match, such <A HREF="motion.html#as">as</A> <A HREF="motion.html#<Tab>"><Tab></A> or
CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
When <A HREF="#'wildmode'">'wildmode'</A> is used, "wildmenu" mode is used where "full" is
specified. "longest" and "<A HREF="eval.html#list">list</A>" <A HREF="diff.html#do">do</A> not start "wildmenu" mode.
You can check the current mode with |<A HREF="eval.html#wildmenumode()">wildmenumode()</A>|.
If there are more matches than can fit in the line, a "<A HREF="change.html#>">></A>" is shown on
the right and/or a "<A HREF="change.html#<"><</A>" is shown on the left. The status line scrolls
<A HREF="motion.html#as">as</A> needed.
The "wildmenu" mode is abandoned when a key is hit that is not used
for selecting a completion.
While the "wildmenu" is active the following keys have special
meanings:
<A HREF="motion.html#<Left>"><Left></A> <A HREF="motion.html#<Right>"><Right></A> - select previous/next match (like CTRL-P/CTRL-N)
<A HREF="motion.html#<Down>"><Down></A> - in filename/menu name completion: move into a
subdirectory or submenu.
<A HREF="motion.html#<CR>"><CR></A> - in menu completion, when the cursor is just after a
dot: move into a submenu.
<A HREF="motion.html#<Up>"><Up></A> - in filename/menu name completion: move up into
parent directory or parent menu.
This makes the menus accessible from the console |<A HREF="gui.html#console-menus">console-menus</A>|.
If you prefer the <A HREF="motion.html#<Left>"><Left></A> and <A HREF="motion.html#<Right>"><Right></A> keys to move the cursor instead
of selecting a different match, use this:
<B> :cnoremap <Left> <Space><BS><Left></B>
<B> :cnoremap <Right> <Space><BS><Right></B>
The "WildMenu" highlighting is used for displaying the current match
|<A HREF="syntax.html#hl-WildMenu">hl-WildMenu</A>|.
*<A NAME="'wildmode'"></A><B>'wildmode'</B>* *<A NAME="'wim'"></A><B>'wim'</B>*
<A HREF="#'wildmode'">'wildmode'</A> <A HREF="#'wim'">'wim'</A> <A HREF="eval.html#string">string</A> (Vim default: "full")
global
{not in Vi}
Completion mode that is used for the character specified with
<A HREF="#'wildchar'">'wildchar'</A>. It is a comma separated <A HREF="eval.html#list">list</A> of up to four parts. Each
part specifies what to <A HREF="diff.html#do">do</A> for each consecutive use of <A HREF="#'wildchar'">'wildchar'</A>. The
first part specifies the behavior for the first use of <A HREF="#'wildchar'">'wildchar'</A>,
The second part for the second use, etc.
These are the possible values for each part:
"" Complete only the first match.
"full" Complete the next full match. After the last match,
the original <A HREF="eval.html#string">string</A> is used and then the first match
again.
"longest" Complete till longest common <A HREF="eval.html#string">string</A>. If this doesn't
result in a longer <A HREF="eval.html#string">string</A>, use the next part.
"longest:full" Like "longest", but also start <A HREF="#'wildmenu'">'wildmenu'</A> if <A HREF="motion.html#it">it</A> is
enabled.
"<A HREF="eval.html#list">list</A>" When more than one match, <A HREF="eval.html#list">list</A> all matches.
"list:full" When more than one match, <A HREF="eval.html#list">list</A> all matches and
complete first match.
"list:longest" When more than one match, <A HREF="eval.html#list">list</A> all matches and
complete till longest common <A HREF="eval.html#string">string</A>.
When there is only a single match, <A HREF="motion.html#it">it</A> is fully completed in all cases.
Examples:
<B> :set wildmode=full</B>
Complete first full match, next match, etc. (the default)
<B> :set wildmode=longest,full</B>
Complete longest common <A HREF="eval.html#string">string</A>, then each full match
<B> :set wildmode=list:full</B>
<A HREF="eval.html#List">List</A> all matches and complete each full match
<B> :set wildmode=list,full</B>
<A HREF="eval.html#List">List</A> all matches without completing, then each full match
<B> :set wildmode=longest,list</B>
Complete longest common <A HREF="eval.html#string">string</A>, then <A HREF="eval.html#list">list</A> alternatives.
More info here: |<A HREF="cmdline.html#cmdline-completion">cmdline-completion</A>|.
*<A NAME="'wildoptions'"></A><B>'wildoptions'</B>* *<A NAME="'wop'"></A><B>'wop'</B>*
<A HREF="#'wildoptions'">'wildoptions'</A> <A HREF="#'wop'">'wop'</A> <A HREF="eval.html#string">string</A> (default "")
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+wildignore">+wildignore</A>|
feature}
A <A HREF="eval.html#list">list</A> of words that change how command line completion is done.
Currently only one <A HREF="motion.html#word">word</A> is allowed:
tagfile When using <A HREF="scroll.html#CTRL-D">CTRL-D</A> to <A HREF="eval.html#list">list</A> matching <A HREF="tagsrch.html#tags">tags</A>, the kind of
<A HREF="tagsrch.html#tag">tag</A> and the file of the <A HREF="tagsrch.html#tag">tag</A> is listed. Only one match
is displayed per line. Often used <A HREF="tagsrch.html#tag">tag</A> kinds are:
<A HREF="change.html#d">d</A> #define
<A HREF="motion.html#f">f</A> function
Also see |<A HREF="cmdline.html#cmdline-completion">cmdline-completion</A>|.
*<A NAME="'winaltkeys'"></A><B>'winaltkeys'</B>* *<A NAME="'wak'"></A><B>'wak'</B>*
<A HREF="#'winaltkeys'">'winaltkeys'</A> <A HREF="#'wak'">'wak'</A> <A HREF="eval.html#string">string</A> (default "menu")
global
{not in Vi}
{only used in <A HREF="os_win32.html#Win32">Win32</A>, <A HREF="gui_x11.html#Motif">Motif</A>, <A HREF="gui_x11.html#GTK">GTK</A> and Photon GUI}
Some <A HREF="gui.html#GUI">GUI</A> versions allow the access to menu entries by using the ALT
key in combination with a character that appears underlined in the
menu. This conflicts with the use of the ALT key for mappings and
entering special characters. This option tells what to <A HREF="diff.html#do">do</A>:
no Don't use ALT keys for <A HREF="gui.html#menus">menus</A>. ALT key combinations can be
mapped, but there is no automatic handling. This can then be
done with the |<A HREF="gui_w32.html#:simalt">:simalt</A>| command.
yes ALT key handling is done by the windowing system. ALT key
combinations cannot be mapped.
menu Using ALT in combination with a character that is a menu
shortcut key, will be handled by the windowing system. Other
keys can be mapped.
If the menu is disabled by excluding '<A HREF="motion.html#m">m</A>' from <A HREF="#'guioptions'">'guioptions'</A>, the ALT
key is never used for the menu.
This option is not used for <A HREF="term.html#<F10>"><F10></A>; on <A HREF="os_win32.html#Win32">Win32</A> and with <A HREF="gui_x11.html#GTK">GTK</A> <A HREF="term.html#<F10>"><F10></A> will
select the menu, unless <A HREF="motion.html#it">it</A> has been mapped.
*<A NAME="'window'"></A><B>'window'</B>* *<A NAME="'wi'"></A><B>'wi'</B>*
<A HREF="#'window'">'window'</A> <A HREF="#'wi'">'wi'</A> number (default screen height - 1)
global
Window height. Do not confuse this with the height of the Vim <A HREF="windows.html#window">window</A>,
use <A HREF="#'lines'">'lines'</A> for that.
Used for |<A HREF="scroll.html#CTRL-F">CTRL-F</A>| and |<A HREF="scroll.html#CTRL-B">CTRL-B</A>| when there is only one <A HREF="windows.html#window">window</A> and the
value is smaller than <A HREF="#'lines'">'lines'</A> minus one. The screen will scroll
<A HREF="#'window'">'window'</A> minus two lines, with a minimum of one.
When <A HREF="#'window'">'window'</A> is equal to <A HREF="#'lines'">'lines'</A> minus one <A HREF="scroll.html#CTRL-F">CTRL-F</A> and <A HREF="scroll.html#CTRL-B">CTRL-B</A> scroll
in a much smarter way, taking care of wrapping lines.
When resizing the Vim <A HREF="windows.html#window">window</A>, the value is smaller than 1 or more than
or equal to <A HREF="#'lines'">'lines'</A> <A HREF="motion.html#it">it</A> will be set to <A HREF="#'lines'">'lines'</A> minus 1.
{Vi also uses the option to specify the number of displayed lines}
*<A NAME="'winheight'"></A><B>'winheight'</B>* *<A NAME="'wh'"></A><B>'wh'</B>* *<A NAME="E591"></A><B>E591</B>*
<A HREF="#'winheight'">'winheight'</A> <A HREF="#'wh'">'wh'</A> number (default 1)
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+windows">+windows</A>|
feature}
Minimal number of lines for the current <A HREF="windows.html#window">window</A>. This is not a hard
minimum, Vim will use fewer lines if there is not enough room. If the
focus goes to a <A HREF="windows.html#window">window</A> that is smaller, its size is increased, at the
cost of the height of other <A HREF="windows.html#windows">windows</A>.
Set <A HREF="#'winheight'">'winheight'</A> to a small number for normal editing.
Set <A HREF="motion.html#it">it</A> to 999 to make the current <A HREF="windows.html#window">window</A> fill most of the screen.
Other <A HREF="windows.html#windows">windows</A> will be only <A HREF="#'winminheight'">'winminheight'</A> high. This has the drawback
that "<A HREF="windows.html#:all">:all</A>" will create only two <A HREF="windows.html#windows">windows</A>. To avoid "vim <A HREF="starting.html#-o">-o</A> 1 2 3 4"
to create only two <A HREF="windows.html#windows">windows</A>, set the option after <A HREF="starting.html#startup">startup</A> is done,
using the |<A HREF="autocmd.html#VimEnter">VimEnter</A>| event:
<B> au VimEnter * set winheight=999</B>
Minimum value is 1.
The height is not adjusted after one of the commands that change the
height of the current <A HREF="windows.html#window">window</A>.
<A HREF="#'winheight'">'winheight'</A> applies to the current <A HREF="windows.html#window">window</A>. Use <A HREF="#'winminheight'">'winminheight'</A> to set
the minimal height for other <A HREF="windows.html#windows">windows</A>.
*<A NAME="'winfixheight'"></A><B>'winfixheight'</B>* *<A NAME="'wfh'"></A><B>'wfh'</B>* *<A NAME="'nowinfixheight'"></A><B>'nowinfixheight'</B>* *<A NAME="'nowfh'"></A><B>'nowfh'</B>*
<A HREF="#'winfixheight'">'winfixheight'</A> <A HREF="#'wfh'">'wfh'</A> <A HREF="#boolean">boolean</A> (default off)
local to <A HREF="windows.html#window">window</A>
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+windows">+windows</A>|
feature}
Keep the <A HREF="windows.html#window">window</A> height when <A HREF="windows.html#windows">windows</A> are opened or closed and
<A HREF="#'equalalways'">'equalalways'</A> is set. Also for |<A HREF="windows.html#CTRL-W_=">CTRL-W_=</A>|. Set by default for the
|<A HREF="windows.html#preview-window">preview-window</A>| and |<A HREF="quickfix.html#quickfix-window">quickfix-window</A>|.
The height may be changed anyway when running out of room.
*<A NAME="'winfixwidth'"></A><B>'winfixwidth'</B>* *<A NAME="'wfw'"></A><B>'wfw'</B>* *<A NAME="'nowinfixwidth'"></A><B>'nowinfixwidth'</B>* *<A NAME="'nowfw'"></A><B>'nowfw'</B>*
<A HREF="#'winfixwidth'">'winfixwidth'</A> <A HREF="#'wfw'">'wfw'</A> <A HREF="#boolean">boolean</A> (default off)
local to <A HREF="windows.html#window">window</A>
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+windows">+windows</A>|
feature}
Keep the <A HREF="windows.html#window">window</A> width when <A HREF="windows.html#windows">windows</A> are opened or closed and
<A HREF="#'equalalways'">'equalalways'</A> is set. Also for |<A HREF="windows.html#CTRL-W_=">CTRL-W_=</A>|.
The width may be changed anyway when running out of room.
*<A NAME="'winminheight'"></A><B>'winminheight'</B>* *<A NAME="'wmh'"></A><B>'wmh'</B>*
<A HREF="#'winminheight'">'winminheight'</A> <A HREF="#'wmh'">'wmh'</A> number (default 1)
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+windows">+windows</A>|
feature}
The minimal height of a <A HREF="windows.html#window">window</A>, when it's not the current <A HREF="windows.html#window">window</A>.
This is a hard minimum, <A HREF="windows.html#windows">windows</A> will never become smaller.
When set to zero, <A HREF="windows.html#windows">windows</A> may be "squashed" to zero lines (i.e. just a
status <A HREF="motion.html#bar">bar</A>) if necessary. They will return to at least one line when
they become active (since the cursor has to have somewhere to go.)
Use <A HREF="#'winheight'">'winheight'</A> to set the minimal height of the current <A HREF="windows.html#window">window</A>.
This option is only checked when making a <A HREF="windows.html#window">window</A> smaller. Don't use a
large number, <A HREF="motion.html#it">it</A> will cause <A HREF="message.html#errors">errors</A> when opening more than a few
<A HREF="windows.html#windows">windows</A>. A value of 0 to 3 is reasonable.
*<A NAME="'winminwidth'"></A><B>'winminwidth'</B>* *<A NAME="'wmw'"></A><B>'wmw'</B>*
<A HREF="#'winminwidth'">'winminwidth'</A> <A HREF="#'wmw'">'wmw'</A> number (default 1)
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+vertsplit">+vertsplit</A>|
feature}
The minimal width of a <A HREF="windows.html#window">window</A>, when it's not the current <A HREF="windows.html#window">window</A>.
This is a hard minimum, <A HREF="windows.html#windows">windows</A> will never become smaller.
When set to zero, <A HREF="windows.html#windows">windows</A> may be "squashed" to zero columns (i.e. just
a vertical separator) if necessary. They will return to at least one
line when they become active (since the cursor has to have somewhere
to go.)
Use <A HREF="#'winwidth'">'winwidth'</A> to set the minimal width of the current <A HREF="windows.html#window">window</A>.
This option is only checked when making a <A HREF="windows.html#window">window</A> smaller. Don't use a
large number, <A HREF="motion.html#it">it</A> will cause <A HREF="message.html#errors">errors</A> when opening more than a few
<A HREF="windows.html#windows">windows</A>. A value of 0 to 12 is reasonable.
*<A NAME="'winptydll'"></A><B>'winptydll'</B>*
<A HREF="#'winptydll'">'winptydll'</A> <A HREF="eval.html#string">string</A> (default "winpty32.dll" or "winpty64.dll")
global
{not in Vi}
{only available when compiled with the |<A HREF="terminal.html#terminal">terminal</A>|
feature on MS-Windows}
Specifies the name of the winpty shared library, used for the
|<A HREF="terminal.html#:terminal">:terminal</A>| command. The default depends on whether was build <A HREF="motion.html#as">as</A> a
32-bit or 64-bit executable. If not found, "winpty.dll" is tried <A HREF="motion.html#as">as</A>
a fallback.
Environment <A HREF="eval.html#variables">variables</A> are expanded |<A HREF="#:set_env">:set_env</A>|.
This option cannot be set from a |<A HREF="#modeline">modeline</A>| or in the |<A HREF="eval.html#sandbox">sandbox</A>|, for
security reasons.
*<A NAME="'winwidth'"></A><B>'winwidth'</B>* *<A NAME="'wiw'"></A><B>'wiw'</B>* *<A NAME="E592"></A><B>E592</B>*
<A HREF="#'winwidth'">'winwidth'</A> <A HREF="#'wiw'">'wiw'</A> number (default 20)
global
{not in Vi}
{not available when compiled without the |<A HREF="various.html#+vertsplit">+vertsplit</A>|
feature}
Minimal number of columns for the current <A HREF="windows.html#window">window</A>. This is not a hard
minimum, Vim will use fewer columns if there is not enough room. If
the current <A HREF="windows.html#window">window</A> is smaller, its size is increased, at the cost of
the width of other <A HREF="windows.html#windows">windows</A>. Set <A HREF="motion.html#it">it</A> to 999 to make the current <A HREF="windows.html#window">window</A>
always fill the screen. Set <A HREF="motion.html#it">it</A> to a small number for normal editing.
The width is not adjusted after one of the commands to change the
width of the current <A HREF="windows.html#window">window</A>.
<A HREF="#'winwidth'">'winwidth'</A> applies to the current <A HREF="windows.html#window">window</A>. Use <A HREF="#'winminwidth'">'winminwidth'</A> to set
the minimal width for other <A HREF="windows.html#windows">windows</A>.
*<A NAME="'wrap'"></A><B>'wrap'</B>* *<A NAME="'nowrap'"></A><B>'nowrap'</B>*
<A HREF="#'wrap'">'wrap'</A> <A HREF="#boolean">boolean</A> (default on)
local to <A HREF="windows.html#window">window</A>
{not in Vi}
This option changes how text is displayed. It doesn't change the text
in the buffer, see <A HREF="#'textwidth'">'textwidth'</A> for that.
When on, lines longer than the width of the <A HREF="windows.html#window">window</A> will wrap and
displaying continues on the next line. When off lines will not wrap
and only part of long lines will be displayed. When the cursor is
moved to a part that is not shown, the screen will scroll
horizontally.
The line will be broken in the middle of a <A HREF="motion.html#word">word</A> if necessary. See
<A HREF="#'linebreak'">'linebreak'</A> to get the break at a <A HREF="motion.html#word">word</A> boundary.
To make <A HREF="scroll.html#scrolling">scrolling</A> horizontally a bit more useful, try this:
<B> :set sidescroll=5</B>
<B> :set listchars+=precedes:<,extends:></B>
See <A HREF="#'sidescroll'">'sidescroll'</A>, <A HREF="#'listchars'">'listchars'</A> and |<A HREF="intro.html#wrap-off">wrap-off</A>|.
This option can't be set from a |<A HREF="#modeline">modeline</A>| when the <A HREF="#'diff'">'diff'</A> option is
on.
*<A NAME="'wrapmargin'"></A><B>'wrapmargin'</B>* *<A NAME="'wm'"></A><B>'wm'</B>*
<A HREF="#'wrapmargin'">'wrapmargin'</A> <A HREF="#'wm'">'wm'</A> number (default 0)
local to buffer
<A HREF="eval.html#Number">Number</A> of characters from the right <A HREF="windows.html#window">window</A> border where wrapping
starts. When typing text beyond this limit, an <A HREF="intro.html#<EOL>"><EOL></A> will be inserted
and <A HREF="insert.html#inserting">inserting</A> continues on the next line.
Options that add a margin, such <A HREF="motion.html#as">as</A> <A HREF="#'number'">'number'</A> and <A HREF="#'foldcolumn'">'foldcolumn'</A>, cause
the text width to be further reduced. This is <A HREF="intro.html#Vi">Vi</A> compatible.
When <A HREF="#'textwidth'">'textwidth'</A> is non-zero, this option is not used.
This option is set to 0 when <A HREF="#'paste'">'paste'</A> is set and restored when <A HREF="#'paste'">'paste'</A>
is reset.
See also <A HREF="#'formatoptions'">'formatoptions'</A> and |<A HREF="insert.html#ins-textwidth">ins-textwidth</A>|. {Vi: works differently
and <A HREF="various.html#less">less</A> usefully}
*<A NAME="'wrapscan'"></A><B>'wrapscan'</B>* *<A NAME="'ws'"></A><B>'ws'</B>* *<A NAME="'nowrapscan'"></A><B>'nowrapscan'</B>* *<A NAME="'nows'"></A><B>'nows'</B>*
<A HREF="#'wrapscan'">'wrapscan'</A> <A HREF="#'ws'">'ws'</A> <A HREF="#boolean">boolean</A> (default on) *<A NAME="E384"></A><B>E384</B>* *<A NAME="E385"></A><B>E385</B>*
global
Searches wrap around the end of the file. Also applies to |<A HREF="spell.html#]s">]s</A>| and
|<A HREF="spell.html#[s">[s</A>|, searching for spelling mistakes.
*<A NAME="'write'"></A><B>'write'</B>* *<A NAME="'nowrite'"></A><B>'nowrite'</B>*
<A HREF="#'write'">'write'</A> <A HREF="#boolean">boolean</A> (default on)
global
{not in Vi}
Allows <A HREF="editing.html#writing">writing</A> files. When not set, <A HREF="editing.html#writing">writing</A> a file is not allowed.
Can be used for a view-only mode, where modifications to the text are
still allowed. Can be reset with the |<A HREF="starting.html#-m">-m</A>| or |<A HREF="starting.html#-M">-M</A>| command line
argument. Filtering text is still possible, even though this requires
<A HREF="editing.html#writing">writing</A> a temporary file.
*<A NAME="'writeany'"></A><B>'writeany'</B>* *<A NAME="'wa'"></A><B>'wa'</B>* *<A NAME="'nowriteany'"></A><B>'nowriteany'</B>* *<A NAME="'nowa'"></A><B>'nowa'</B>*
<A HREF="#'writeany'">'writeany'</A> <A HREF="#'wa'">'wa'</A> <A HREF="#boolean">boolean</A> (default off)
global
Allows <A HREF="editing.html#writing">writing</A> to any file with no need for "<A HREF="change.html#!">!</A>" override.
*<A NAME="'writebackup'"></A><B>'writebackup'</B>* *<A NAME="'wb'"></A><B>'wb'</B>* *<A NAME="'nowritebackup'"></A><B>'nowritebackup'</B>* *<A NAME="'nowb'"></A><B>'nowb'</B>*
<A HREF="#'writebackup'">'writebackup'</A> <A HREF="#'wb'">'wb'</A> <A HREF="#boolean">boolean</A> (default on with |<A HREF="various.html#+writebackup">+writebackup</A>| feature, off
otherwise)
global
{not in Vi}
Make a <A HREF="editing.html#backup">backup</A> before overwriting a file. The <A HREF="editing.html#backup">backup</A> is removed after
the file was successfully written, unless the <A HREF="#'backup'">'backup'</A> option is
also on.
WARNING: Switching this option off means that when Vim fails to write
your buffer correctly and then, for whatever reason, Vim exits, you
lose both the original file and what you were <A HREF="editing.html#writing">writing</A>. Only reset
this option if your file system is almost full and <A HREF="motion.html#it">it</A> makes the write
fail (and make sure not to exit Vim until the write was successful).
See |<A HREF="editing.html#backup-table">backup-table</A>| for another explanation.
When the <A HREF="#'backupskip'">'backupskip'</A> <A HREF="pattern.html#pattern">pattern</A> matches, a <A HREF="editing.html#backup">backup</A> is not made anyway.
NOTE: This option is set to the default value when <A HREF="#'compatible'">'compatible'</A> is
set.
*<A NAME="'writedelay'"></A><B>'writedelay'</B>* *<A NAME="'wd'"></A><B>'wd'</B>*
<A HREF="#'writedelay'">'writedelay'</A> <A HREF="#'wd'">'wd'</A> number (default 0)
global
{not in Vi}
The number of milliseconds to wait for each character sent to the
screen. When non-zero, characters are sent to the <A HREF="terminal.html#terminal">terminal</A> one by
one. For <A HREF="os_msdos.html#MS-DOS">MS-DOS</A> pcterm this does not work. For debugging purposes.
<A HREF="#top">top</A> - <A HREF="index.html">main help file</A>
</PRE>
</BODY>
</HTML>
|