/usr/share/doc/calcurse/manual.html is in calcurse 4.0.0-1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.9" />
<title>CALCURSE - text-based organizer</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
/* Default font. */
body {
font-family: Georgia,serif;
}
/* Title font. */
h1, h2, h3, h4, h5, h6,
div.title, caption.title,
thead, p.table.header,
#toctitle,
#author, #revnumber, #revdate, #revremark,
#footer {
font-family: Arial,Helvetica,sans-serif;
}
body {
margin: 1em 5% 1em 5%;
}
a {
color: blue;
text-decoration: underline;
}
a:visited {
color: fuchsia;
}
em {
font-style: italic;
color: navy;
}
strong {
font-weight: bold;
color: #083194;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1, h2, h3 {
border-bottom: 2px solid silver;
}
h2 {
padding-top: 0.5em;
}
h3 {
float: left;
}
h3 + * {
clear: left;
}
h5 {
font-size: 1.0em;
}
div.sectionbody {
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
ul, ol, li > p {
margin-top: 0;
}
ul > li { color: #aaa; }
ul > li > * { color: black; }
.monospaced, code, pre {
font-family: "Courier New", Courier, monospace;
font-size: inherit;
color: navy;
padding: 0;
margin: 0;
}
pre {
white-space: pre-wrap;
}
#author {
color: #527bbd;
font-weight: bold;
font-size: 1.1em;
}
#email {
}
#revnumber, #revdate, #revremark {
}
#footer {
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
#footer-text {
float: left;
padding-bottom: 0.5em;
}
#footer-badges {
float: right;
padding-bottom: 0.5em;
}
#preamble {
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
div.admonitionblock {
margin-top: 2.0em;
margin-bottom: 2.0em;
margin-right: 10%;
color: #606060;
}
div.content { /* Block element content. */
padding: 0;
}
/* Block element titles. */
div.title, caption.title {
color: #527bbd;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
margin-bottom: 0.5em;
}
div.title + * {
margin-top: 0;
}
td div.title:first-child {
margin-top: 0.0em;
}
div.content div.title:first-child {
margin-top: 0.0em;
}
div.content + div.title {
margin-top: 0.0em;
}
div.sidebarblock > div.content {
background: #ffffee;
border: 1px solid #dddddd;
border-left: 4px solid #f0f0f0;
padding: 0.5em;
}
div.listingblock > div.content {
border: 1px solid #dddddd;
border-left: 5px solid #f0f0f0;
background: #f8f8f8;
padding: 0.5em;
}
div.quoteblock, div.verseblock {
padding-left: 1.0em;
margin-left: 1.0em;
margin-right: 10%;
border-left: 5px solid #f0f0f0;
color: #888;
}
div.quoteblock > div.attribution {
padding-top: 0.5em;
text-align: right;
}
div.verseblock > pre.content {
font-family: inherit;
font-size: inherit;
}
div.verseblock > div.attribution {
padding-top: 0.75em;
text-align: left;
}
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
div.verseblock + div.attribution {
text-align: left;
}
div.admonitionblock .icon {
vertical-align: top;
font-size: 1.1em;
font-weight: bold;
text-decoration: underline;
color: #527bbd;
padding-right: 0.5em;
}
div.admonitionblock td.content {
padding-left: 0.5em;
border-left: 3px solid #dddddd;
}
div.exampleblock > div.content {
border-left: 3px solid #dddddd;
padding-left: 0.5em;
}
div.imageblock div.content { padding-left: 0; }
span.image img { border-style: none; vertical-align: text-bottom; }
a.image:visited { color: white; }
dl {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
dt {
margin-top: 0.5em;
margin-bottom: 0;
font-style: normal;
color: navy;
}
dd > *:first-child {
margin-top: 0.1em;
}
ul, ol {
list-style-position: outside;
}
ol.arabic {
list-style-type: decimal;
}
ol.loweralpha {
list-style-type: lower-alpha;
}
ol.upperalpha {
list-style-type: upper-alpha;
}
ol.lowerroman {
list-style-type: lower-roman;
}
ol.upperroman {
list-style-type: upper-roman;
}
div.compact ul, div.compact ol,
div.compact p, div.compact p,
div.compact div, div.compact div {
margin-top: 0.1em;
margin-bottom: 0.1em;
}
tfoot {
font-weight: bold;
}
td > div.verse {
white-space: pre;
}
div.hdlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
div.hdlist tr {
padding-bottom: 15px;
}
dt.hdlist1.strong, td.hdlist1.strong {
font-weight: bold;
}
td.hdlist1 {
vertical-align: top;
font-style: normal;
padding-right: 0.8em;
color: navy;
}
td.hdlist2 {
vertical-align: top;
}
div.hdlist.compact tr {
margin: 0;
padding-bottom: 0;
}
.comment {
background: yellow;
}
.footnote, .footnoteref {
font-size: 0.8em;
}
span.footnote, span.footnoteref {
vertical-align: super;
}
#footnotes {
margin: 20px 0 20px 0;
padding: 7px 0 0 0;
}
#footnotes div.footnote {
margin: 0 0 5px 0;
}
#footnotes hr {
border: none;
border-top: 1px solid silver;
height: 1px;
text-align: left;
margin-left: 0;
width: 20%;
min-width: 100px;
}
div.colist td {
padding-right: 0.5em;
padding-bottom: 0.3em;
vertical-align: top;
}
div.colist td img {
margin-top: 0.3em;
}
@media print {
#footer-badges { display: none; }
}
#toc {
margin-bottom: 2.5em;
}
#toctitle {
color: #527bbd;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
font-size: 0.9em;
}
div.toclevel3 {
margin-left: 4em;
font-size: 0.9em;
}
div.toclevel4 {
margin-left: 6em;
font-size: 0.9em;
}
span.aqua { color: aqua; }
span.black { color: black; }
span.blue { color: blue; }
span.fuchsia { color: fuchsia; }
span.gray { color: gray; }
span.green { color: green; }
span.lime { color: lime; }
span.maroon { color: maroon; }
span.navy { color: navy; }
span.olive { color: olive; }
span.purple { color: purple; }
span.red { color: red; }
span.silver { color: silver; }
span.teal { color: teal; }
span.white { color: white; }
span.yellow { color: yellow; }
span.aqua-background { background: aqua; }
span.black-background { background: black; }
span.blue-background { background: blue; }
span.fuchsia-background { background: fuchsia; }
span.gray-background { background: gray; }
span.green-background { background: green; }
span.lime-background { background: lime; }
span.maroon-background { background: maroon; }
span.navy-background { background: navy; }
span.olive-background { background: olive; }
span.purple-background { background: purple; }
span.red-background { background: red; }
span.silver-background { background: silver; }
span.teal-background { background: teal; }
span.white-background { background: white; }
span.yellow-background { background: yellow; }
span.big { font-size: 2em; }
span.small { font-size: 0.6em; }
span.underline { text-decoration: underline; }
span.overline { text-decoration: overline; }
span.line-through { text-decoration: line-through; }
div.unbreakable { page-break-inside: avoid; }
/*
* xhtml11 specific
*
* */
div.tableblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
div.tableblock > table {
border: 3px solid #527bbd;
}
thead, p.table.header {
font-weight: bold;
color: #527bbd;
}
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
div.tableblock > table[frame="hsides"] {
border-left-style: none;
border-right-style: none;
}
div.tableblock > table[frame="vsides"] {
border-top-style: none;
border-bottom-style: none;
}
/*
* html5 specific
*
* */
table.tableblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
thead, p.tableblock.header {
font-weight: bold;
color: #527bbd;
}
p.tableblock {
margin-top: 0;
}
table.tableblock {
border-width: 3px;
border-spacing: 0px;
border-style: solid;
border-color: #527bbd;
border-collapse: collapse;
}
th.tableblock, td.tableblock {
border-width: 1px;
padding: 4px;
border-style: solid;
border-color: #527bbd;
}
table.tableblock.frame-topbot {
border-left-style: hidden;
border-right-style: hidden;
}
table.tableblock.frame-sides {
border-top-style: hidden;
border-bottom-style: hidden;
}
table.tableblock.frame-none {
border-style: hidden;
}
th.tableblock.halign-left, td.tableblock.halign-left {
text-align: left;
}
th.tableblock.halign-center, td.tableblock.halign-center {
text-align: center;
}
th.tableblock.halign-right, td.tableblock.halign-right {
text-align: right;
}
th.tableblock.valign-top, td.tableblock.valign-top {
vertical-align: top;
}
th.tableblock.valign-middle, td.tableblock.valign-middle {
vertical-align: middle;
}
th.tableblock.valign-bottom, td.tableblock.valign-bottom {
vertical-align: bottom;
}
/*
* manpage specific
*
* */
body.manpage h1 {
padding-top: 0.5em;
padding-bottom: 0.5em;
border-top: 2px solid silver;
border-bottom: 2px solid silver;
}
body.manpage h2 {
border-style: none;
}
body.manpage div.sectionbody {
margin-left: 3em;
}
@media print {
body.manpage div#toc { display: none; }
}
</style>
<script type="text/javascript">
/*<![CDATA[*/
var asciidoc = { // Namespace.
/////////////////////////////////////////////////////////////////////
// Table Of Contents generator
/////////////////////////////////////////////////////////////////////
/* Author: Mihai Bazon, September 2002
* http://students.infoiasi.ro/~mishoo
*
* Table Of Content generator
* Version: 0.4
*
* Feel free to use this script under the terms of the GNU General Public
* License, as long as you do not remove or alter this notice.
*/
/* modified by Troy D. Hanson, September 2006. License: GPL */
/* modified by Stuart Rackham, 2006, 2009. License: GPL */
// toclevels = 1..4.
toc: function (toclevels) {
function getText(el) {
var text = "";
for (var i = el.firstChild; i != null; i = i.nextSibling) {
if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
text += i.data;
else if (i.firstChild != null)
text += getText(i);
}
return text;
}
function TocEntry(el, text, toclevel) {
this.element = el;
this.text = text;
this.toclevel = toclevel;
}
function tocEntries(el, toclevels) {
var result = new Array;
var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
// Function that scans the DOM tree for header elements (the DOM2
// nodeIterator API would be a better technique but not supported by all
// browsers).
var iterate = function (el) {
for (var i = el.firstChild; i != null; i = i.nextSibling) {
if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
var mo = re.exec(i.tagName);
if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
}
iterate(i);
}
}
}
iterate(el);
return result;
}
var toc = document.getElementById("toc");
if (!toc) {
return;
}
// Delete existing TOC entries in case we're reloading the TOC.
var tocEntriesToRemove = [];
var i;
for (i = 0; i < toc.childNodes.length; i++) {
var entry = toc.childNodes[i];
if (entry.nodeName.toLowerCase() == 'div'
&& entry.getAttribute("class")
&& entry.getAttribute("class").match(/^toclevel/))
tocEntriesToRemove.push(entry);
}
for (i = 0; i < tocEntriesToRemove.length; i++) {
toc.removeChild(tocEntriesToRemove[i]);
}
// Rebuild TOC entries.
var entries = tocEntries(document.getElementById("content"), toclevels);
for (var i = 0; i < entries.length; ++i) {
var entry = entries[i];
if (entry.element.id == "")
entry.element.id = "_toc_" + i;
var a = document.createElement("a");
a.href = "#" + entry.element.id;
a.appendChild(document.createTextNode(entry.text));
var div = document.createElement("div");
div.appendChild(a);
div.className = "toclevel" + entry.toclevel;
toc.appendChild(div);
}
if (entries.length == 0)
toc.parentNode.removeChild(toc);
},
/////////////////////////////////////////////////////////////////////
// Footnotes generator
/////////////////////////////////////////////////////////////////////
/* Based on footnote generation code from:
* http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
*/
footnotes: function () {
// Delete existing footnote entries in case we're reloading the footnodes.
var i;
var noteholder = document.getElementById("footnotes");
if (!noteholder) {
return;
}
var entriesToRemove = [];
for (i = 0; i < noteholder.childNodes.length; i++) {
var entry = noteholder.childNodes[i];
if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
entriesToRemove.push(entry);
}
for (i = 0; i < entriesToRemove.length; i++) {
noteholder.removeChild(entriesToRemove[i]);
}
// Rebuild footnote entries.
var cont = document.getElementById("content");
var spans = cont.getElementsByTagName("span");
var refs = {};
var n = 0;
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnote") {
n++;
var note = spans[i].getAttribute("data-note");
if (!note) {
// Use [\s\S] in place of . so multi-line matches work.
// Because JavaScript has no s (dotall) regex flag.
note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
spans[i].innerHTML =
"[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
spans[i].setAttribute("data-note", note);
}
noteholder.innerHTML +=
"<div class='footnote' id='_footnote_" + n + "'>" +
"<a href='#_footnoteref_" + n + "' title='Return to text'>" +
n + "</a>. " + note + "</div>";
var id =spans[i].getAttribute("id");
if (id != null) refs["#"+id] = n;
}
}
if (n == 0)
noteholder.parentNode.removeChild(noteholder);
else {
// Process footnoterefs.
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnoteref") {
var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
href = href.match(/#.*/)[0]; // Because IE return full URL.
n = refs[href];
spans[i].innerHTML =
"[<a href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
}
}
}
},
install: function(toclevels) {
var timerId;
function reinstall() {
asciidoc.footnotes();
if (toclevels) {
asciidoc.toc(toclevels);
}
}
function reinstallAndRemoveTimer() {
clearInterval(timerId);
reinstall();
}
timerId = setInterval(reinstall, 500);
if (document.addEventListener)
document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
else
window.onload = reinstallAndRemoveTimer;
}
}
asciidoc.install(2);
/*]]>*/
</script>
</head>
<body class="article">
<div id="header">
<h1>CALCURSE - text-based organizer</h1>
<div id="toc">
<div id="toctitle">Table of Contents</div>
<noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="_abstract">1. Abstract</h2>
<div class="sectionbody">
<div class="paragraph"><p>This manual describes <code>calcurse</code> functionalities, and how to use them. The
installation from source is first described, together with the available
command line arguments. The user interface is then presented, with all of the
customizable options that change <code>calcurse</code> behavior. Last, bug reporting
procedure is explained, as well as the way one can contribute to <code>calcurse</code>
development.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_introduction">2. Introduction</h2>
<div class="sectionbody">
<div class="paragraph"><p><code>calcurse</code> is a text-based calendar and scheduling application. It helps
keeping track of events, appointments and everyday tasks. A configurable
notification system reminds user of upcoming deadlines, and the curses based
interface can be customized to suit user needs. All of the commands are
documented within an online help system.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_overview">3. Overview</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_creation_history">3.1. Creation history</h3>
<div class="paragraph"><p>Frederic started thinking about this project when he was finishing his Ph.D. in
Astrophysics as it started to be a little hard to organize himself and he
really needed a good tool for managing his appointments and todo list.
Unfortunately, he finished his Ph.D. before finishing <code>calcurse</code> but he
continued working on it, hoping it would be helpful to other people.</p></div>
<div class="paragraph"><p>In mid-2010, Lukas took over development of <code>calcurse</code> and is now the main
contributor and reviewer of patches.</p></div>
<div class="paragraph"><p>But why <code>calcurse</code> anyway? Well, it is simply the concatenation of *cal*endar
and *curse*s, the name of the library used to build the user interface.</p></div>
</div>
<div class="sect2">
<h3 id="_important_features">3.2. Important features</h3>
<div class="paragraph"><p><code>Calcurse</code> is multi-platform and intended to be lightweight, fast and reliable.
It is to be used inside a console or terminal, locally or on a distant machine
within an ssh (or similar) connection.</p></div>
<div class="paragraph"><p><code>Calcurse</code> can be run in two different modes : interactive or non-interactive
mode. The first mode allows oneself to view its own personal organizer almost
everywhere, thanks to the text-based interface. The second mode permits to
easily build reminders just by adding <code>calcurse</code> with appropriate command line
arguments inside a cron tab or within a shell init script.</p></div>
<div class="paragraph"><p>Moreover, <code>calcurse</code> was created with the end-user in mind, and tends to be as
friendly as possible. This means a complete on-line help system, together with
having all of the possible actions displayed at any time inside a status bar.
The user interface is configurable, and one can choose between several color
and layout combinations. Key bindings are also configurable, to fit everyone’s
needs. Last, a configurable notification system reminds user of upcoming
appointments. The reminders are sent even if the user’s interface is not
running, as calcurse is able to run in background.</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_installation">4. Installation</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_requirements">4.1. Requirements</h3>
<div class="sect3">
<h4 id="_ncurses_library">4.1.1. ncurses library</h4>
<div class="paragraph"><p><code>Calcurse</code> requires only a <code>C</code> compiler, such as <code>cc</code> or <code>gcc</code>, and the
<code>ncurses</code> library. It would be very surprising not to have a valid <code>ncurses</code>
library already installed on your computer, but if not, you can find it at the
following url: <a href="http://ftp.gnu.org/pub/gnu/ncurses/">http://ftp.gnu.org/pub/gnu/ncurses/</a></p></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="./images/icons/note.png" alt="Note" />
</td>
<td class="content">It is also possible to link <code>calcurse</code> against the <code>ncursesw</code> library
(ncurses with support for unicode).</td>
</tr></table>
</div>
</div>
<div class="sect3">
<h4 id="install_requirements_gettext">4.1.2. gettext library</h4>
<div class="paragraph"><p><code>calcurse</code> supports internationalization (<strong>i18n</strong> hereafter) through the
<code>gettext</code> utilities. This means <code>calcurse</code> can produce multi-lingual messages
if compiled with native language support (i.e. <strong>NLS</strong>).</p></div>
<div class="paragraph"><p>However, <strong>NLS</strong> is optionnal and if you do not want to have support for
multi-lingual messages, you can disable this feature. This is done by giving
the <code>--disable-nls</code> option to <code>configure</code> (see section
<a href="#install_process">Install process</a>). To check if the <code>gettext</code> utilities are
installed on your system, you can search for the <code>libintl.h</code> header file for
instance:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>$ locate libintl.h</code></pre>
</div></div>
<div class="paragraph"><p>If this header file is not found, then you can obtain the <code>gettext</code> sources at
the following url : <a href="http://ftp.gnu.org/pub/gnu/gettext/">http://ftp.gnu.org/pub/gnu/gettext/</a></p></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="./images/icons/note.png" alt="Note" />
</td>
<td class="content">Even if <code>libintl.h</code> is found on your system, it can be wise to specify
its location during the <a href="#install_process">install process</a>, by using the
<code>--with-libintl-prefix</code> option with <code>configure</code>. Indeed, the <code>configure</code>
could fail to locate this library if installed in an uncommon place.</td>
</tr></table>
</div>
</div>
</div>
<div class="sect2">
<h3 id="install_process">4.2. Install process</h3>
<div class="paragraph"><p>First you need to gunzip and untar the source archive:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>$ tar zxvf calcurse-4.0.0.tar.gz</code></pre>
</div></div>
<div class="paragraph"><p>Once you meet the requirements and have extracted the archive, the install
process is quite simple, and follows the standard three steps process:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>$ ./configure
$ make
$ make install # (may require root privilege)</code></pre>
</div></div>
<div class="paragraph"><p>Use <code>./configure --help</code> to obtain a list of possible options.</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_calcurse_basics">5. calcurse basics</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_invocation">5.1. Invocation</h3>
<div class="sect3">
<h4 id="basics_invocation_commandline">5.1.1. Command line arguments</h4>
<div class="paragraph"><p><code>calcurse</code> takes the following options from the command line (both short and
long options are supported):</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<code>-a, --appointment</code>
</dt>
<dd>
<p>
Print the appointments and events for the current day and exit. Equivalent to
<code>-Q --filter-type cal</code>. The calendar from which to read the appointments can
be specified using the <code>-c</code> flag.
</p>
</dd>
<dt class="hdlist1">
<code>-c <file>, --calendar <file></code>
</dt>
<dd>
<p>
Specify the calendar file to use. The default calendar is <code>~/.calcurse/apts</code>
(see section <a href="#basics_files">calcurse files</a>). This option has precedence
over <code>-D</code>.
</p>
</dd>
<dt class="hdlist1">
<code>-d <date|num>, --day <date|num></code>
</dt>
<dd>
<p>
Print the appointments for the given date or for the given number of
upcoming days, depending on the argument format. Two possible formats are
supported:
</p>
<div class="openblock">
<div class="content">
<div class="ulist"><ul>
<li>
<p>
a date (possible formats described below).
</p>
</li>
<li>
<p>
a number <code>n</code>.
</p>
</li>
</ul></div>
</div></div>
<div class="paragraph"><p>In the first case, the appointment list for the specified date will be
returned, while in the second case the appointment list for the <code>n</code> upcoming
days will be returned. As an example, typing <code>calcurse -d 3</code> will display
your appointments for today, tomorrow, and the day after tomorrow.
The first form is equivalent to <code>-Q --filter-type cal --from <date></code>, the
second form is equivalent to <code>-Q --filter-type cal --days <num></code>.</p></div>
<div class="paragraph"><p>Note: as for the <code>-a</code> flag, the calendar from which to read the appointments
can be specified using the <code>-c</code> flag.</p></div>
</dd>
<dt class="hdlist1">
<code>--days <num></code>
</dt>
<dd>
<p>
Specify the length of the range (in days) when used with <code>-Q</code>. Cannot be
combined with <code>--to</code>.
</p>
</dd>
<dt class="hdlist1">
<code>-D <dir>, --directory <dir></code>
</dt>
<dd>
<p>
Specify the data directory to use. If not specified, the default directory is
<code>~/.calcurse/</code>.
</p>
</dd>
<dt class="hdlist1">
<code>--filter-type <type></code>
</dt>
<dd>
<p>
Ignore any items that do not match the type mask. See
<a href="#basics_filters">Filters</a> for details.
</p>
</dd>
<dt class="hdlist1">
<code>--filter-pattern <pattern></code>
</dt>
<dd>
<p>
Ignore any items with a description that does not match the pattern. See
<a href="#basics_filters">Filters</a> for details.
</p>
</dd>
<dt class="hdlist1">
<code>--filter-start-from <date></code>
</dt>
<dd>
<p>
Ignore any items that start before a given date. See
<a href="#basics_filters">Filters</a> for details.
</p>
</dd>
<dt class="hdlist1">
<code>--filter-start-to <date></code>
</dt>
<dd>
<p>
Ignore any items that start after a given date. See
<a href="#basics_filters">Filters</a> for details.
</p>
</dd>
<dt class="hdlist1">
<code>--filter-start-after <date></code>
</dt>
<dd>
<p>
Only include items that start after a given date. See
<a href="#basics_filters">Filters</a> for details.
</p>
</dd>
<dt class="hdlist1">
<code>--filter-start-before <date></code>
</dt>
<dd>
<p>
Only include items that start before a given date. See
<a href="#basics_filters">Filters</a> for details.
</p>
</dd>
<dt class="hdlist1">
<code>--filter-start-range <range></code>
</dt>
<dd>
<p>
Only include items within a given range. See <a href="#basics_filters">Filters</a> for
details.
</p>
</dd>
<dt class="hdlist1">
<code>--filter-end-from <date></code>
</dt>
<dd>
<p>
Ignore any items that end before a given date. See <a href="#basics_filters">Filters</a>
for details.
</p>
</dd>
<dt class="hdlist1">
<code>--filter-end-to <date></code>
</dt>
<dd>
<p>
Ignore any items that end after a given date. See <a href="#basics_filters">Filters</a>
for details.
</p>
</dd>
<dt class="hdlist1">
<code>--filter-end-after <date></code>
</dt>
<dd>
<p>
Only include items that end after a given date. See
<a href="#basics_filters">Filters</a> for details.
</p>
</dd>
<dt class="hdlist1">
<code>--filter-end-before <date></code>
</dt>
<dd>
<p>
Only include items that end before a given date. See
<a href="#basics_filters">Filters</a> for details.
</p>
</dd>
<dt class="hdlist1">
<code>--filter-end-range <range></code>
</dt>
<dd>
<p>
Only include items within a given range. See <a href="#basics_filters">Filters</a> for
details.
</p>
</dd>
<dt class="hdlist1">
<code>--filter-priority <priority></code>
</dt>
<dd>
<p>
Only include items with a given priority. See <a href="#basics_filters">Filters</a> for
details.
</p>
</dd>
<dt class="hdlist1">
<code>--filter-completed</code>
</dt>
<dd>
<p>
Only include completed TODO items. See <a href="#basics_filters">Filters</a> for
details.
</p>
</dd>
<dt class="hdlist1">
<code>--filter-uncompleted</code>
</dt>
<dd>
<p>
Only include uncompleted TODO items. See <a href="#basics_filters">Filters</a> for
details.
</p>
</dd>
<dt class="hdlist1">
<code>--format-apt <format></code>
</dt>
<dd>
<p>
Specify a format to control the output of appointments in non-interactive
mode. See the <a href="#basics_format_strings">Format strings</a> section for detailed
information on format strings.
</p>
</dd>
<dt class="hdlist1">
<code>--format-recur-apt <format></code>
</dt>
<dd>
<p>
Specify a format to control the output of recurrent appointments in
non-interactive mode. See the <a href="#basics_format_strings">Format strings</a>
section for detailed information on format strings.
</p>
</dd>
<dt class="hdlist1">
<code>--format-event <format></code>
</dt>
<dd>
<p>
Specify a format to control the output of events in non-interactive mode. See
the <a href="#basics_format_strings">Format strings</a> section for detailed information
on format strings.
</p>
</dd>
<dt class="hdlist1">
<code>--format-recur-event <format></code>
</dt>
<dd>
<p>
Specify a format to control the output of recurrent events in non-interactive
mode. See the <a href="#basics_format_strings">Format strings</a> section for detailed
information on format strings.
</p>
</dd>
<dt class="hdlist1">
<code>--format-todo <format></code>
</dt>
<dd>
<p>
Specify a format to control the output of todo items in non-interactive mode.
See the <a href="#basics_format_strings">Format strings</a> section for detailed
information on format strings.
</p>
</dd>
<dt class="hdlist1">
<code>--from <date></code>
</dt>
<dd>
<p>
Specify the start date of the range when used with <code>-Q</code>.
</p>
</dd>
<dt class="hdlist1">
<code>-g, --gc</code>
</dt>
<dd>
<p>
Run the garbage collector for note files and exit.
</p>
</dd>
<dt class="hdlist1">
<code>-G, --grep</code>
</dt>
<dd>
<p>
Print appointments and TODO items using the calcurse data file format. The
filter interface can be used to further restrict the output. See also:
<a href="#basics_filters">Filters</a>.
</p>
</dd>
<dt class="hdlist1">
<code>-h, --help</code>
</dt>
<dd>
<p>
Print a short help text describing the supported command-line options,
and exit.
</p>
</dd>
<dt class="hdlist1">
<code>-i <file>, --import <file></code>
</dt>
<dd>
<p>
Import the icalendar data contained in <code>file</code>.
</p>
</dd>
<dt class="hdlist1">
<code>-l <num>, --limit <num></code>
</dt>
<dd>
<p>
Limit the number of results printed to <em>num</em>.
</p>
</dd>
<dt class="hdlist1">
<code>-n, --next</code>
</dt>
<dd>
<p>
Print the next appointment within upcoming 24 hours and exit. The indicated
time is the number of hours and minutes left before this appointment.
</p>
<div class="paragraph"><p>Note: the calendar from which to read the appointments can be specified using
the <code>-c</code> flag.</p></div>
</dd>
<dt class="hdlist1">
<code>-Q, --query</code>
</dt>
<dd>
<p>
Print all appointments inside a given query range, followed by all TODO
items. The query range defaults to the current day and can be changed by
using the <code>--from</code> and <code>--to</code> (or <code>--days</code>) parameters. The filter interface
can be used to further restrict the output. See also:
<a href="#basics_filters">Filters</a>.
</p>
</dd>
<dt class="hdlist1">
<code>-r[num], --range[=num]</code>
</dt>
<dd>
<p>
Print events and appointments for the num number of days and exit. If no num
is given, a range of 1 day is considered. Equivalent to <code>-Q --filter-type cal
--days <num></code>.
</p>
</dd>
<dt class="hdlist1">
<code>--read-only</code>
</dt>
<dd>
<p>
Don’t save configuration nor appointments/todos.
</p>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="./images/icons/warning.png" alt="Warning" />
</td>
<td class="content">Use this this with care! If you run an interactive calcurse instance
in read-only mode, all changes from this session will be lost without warning!</td>
</tr></table>
</div>
</dd>
<dt class="hdlist1">
<code>-s[date], --startday[=date]</code>
</dt>
<dd>
<p>
Print events and appointments from date and exit. If no date is given, the
current day is considered. Equivalent to <code>-Q --filter-type cal --from
<date></code>.
</p>
</dd>
<dt class="hdlist1">
<code>-S<regex>, --search=<regex></code>
</dt>
<dd>
<p>
When used with the <code>-a</code>, <code>-d</code>, <code>-r</code>, <code>-s</code>, or <code>-t</code> flag, print only the items
having a description that matches the given regular expression. Equivalent to
<code>-Q --filter-pattern <regex></code>.
</p>
</dd>
<dt class="hdlist1">
<code>--status</code>
</dt>
<dd>
<p>
Display the status of running instances of calcurse. If calcurse is
running, this will tell if the interactive mode was launched or if
calcurse is running in background. The process pid will also be indicated.
</p>
</dd>
<dt class="hdlist1">
<code>-t[num], --todo[=num]</code>
</dt>
<dd>
<p>
Print the <code>todo</code> list and exit. If the optional number <code>num</code> is given, then
only todos having a priority equal to <code>num</code> will be returned. The priority
number must be between 1 (highest) and 9 (lowest). It is also possible to
specify <code>0</code> for the priority, in which case only completed tasks will be
shown. Equivalent to <code>-Q --filter-type todo</code>, combined with
<code>--filter-priority</code> and <code>--filter-completed</code> or <code>--filter-uncompleted</code>.
</p>
</dd>
<dt class="hdlist1">
<code>--to <date></code>
</dt>
<dd>
<p>
Specify the end date of the range when used with <code>-Q</code>. Cannot be combined
with <code>--days</code>.
</p>
</dd>
<dt class="hdlist1">
<code>-v, --version</code>
</dt>
<dd>
<p>
Display <code>calcurse</code> version and exit.
</p>
</dd>
<dt class="hdlist1">
<code>-x[format], --export[=format]</code>
</dt>
<dd>
<p>
Export user data to specified format. Events, appointments and todos are
converted and echoed to stdout. Two possible formats are available: ical and
pcal (see section <a href="#links_others">Links</a> below). If the optional
argument <code>format</code> is not given, ical format is selected by default.
</p>
<div class="paragraph"><p>Note: redirect standard output to export data to a file, by issuing a command
such as:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>$ calcurse --export > my_data.dat</code></pre>
</div></div>
</dd>
</dl></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="./images/icons/note.png" alt="Note" />
</td>
<td class="content">The <code>-N</code> option has been removed in calcurse 3.0.0. See the
<a href="#basics_format_strings">Format strings</a> section on how to print note along
with appointments and events.</td>
</tr></table>
</div>
</div>
<div class="sect3">
<h4 id="basics_filters">5.1.2. Filters</h4>
<div class="paragraph"><p>Filters can be used to restrict the set of items which are loaded from the
appointments file when using calcurse in non-interactive mode. The following
filters are currently supported:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<code>--filter-type <type></code>
</dt>
<dd>
<p>
Ignore any items that do not match the type mask. The type mask is a
comma-separated list of valid type descriptions which include <code>event</code>, <code>apt</code>,
<code>recur-event</code>, <code>recur-apt</code> and <code>todo</code>. You can also use <code>recur</code> as a
shorthand for <code>recur-event,recur-apt</code> and <code>cal</code> as a shorthand for
<code>event,apt,recur</code>.
</p>
</dd>
<dt class="hdlist1">
<code>--filter-pattern <pattern></code>
</dt>
<dd>
<p>
Ignore any items with a description that does not match the pattern. The
pattern is interpreted as extended regular expression.
</p>
</dd>
<dt class="hdlist1">
<code>--filter-start-from <date></code>
</dt>
<dd>
<p>
Ignore any items that start before a given date.
</p>
</dd>
<dt class="hdlist1">
<code>--filter-start-to <date></code>
</dt>
<dd>
<p>
Ignore any items that start after a given date.
</p>
</dd>
<dt class="hdlist1">
<code>--filter-start-after <date></code>
</dt>
<dd>
<p>
Only include items that start after a given date.
</p>
</dd>
<dt class="hdlist1">
<code>--filter-start-before <date></code>
</dt>
<dd>
<p>
Only include items that start before a given date.
</p>
</dd>
<dt class="hdlist1">
<code>--filter-start-range <range></code>
</dt>
<dd>
<p>
Only include items with a start date that falls within a given range. A range
consists of a start date and an end date, separated by a comma.
</p>
</dd>
<dt class="hdlist1">
<code>--filter-end-from <date></code>
</dt>
<dd>
<p>
Ignore any items that end before a given date.
</p>
</dd>
<dt class="hdlist1">
<code>--filter-end-to <date></code>
</dt>
<dd>
<p>
Ignore any items that end after a given date.
</p>
</dd>
<dt class="hdlist1">
<code>--filter-end-after <date></code>
</dt>
<dd>
<p>
Only include items that end after a given date.
</p>
</dd>
<dt class="hdlist1">
<code>--filter-end-before <date></code>
</dt>
<dd>
<p>
Only include items that end before a given date.
</p>
</dd>
<dt class="hdlist1">
<code>--filter-end-range <range></code>
</dt>
<dd>
<p>
Only include items with an end date that falls within a given range. A range
consists of a start date and an end date, separated by a comma.
</p>
</dd>
<dt class="hdlist1">
<code>--filter-priority <priority></code>
</dt>
<dd>
<p>
Only include items with a given priority.
</p>
</dd>
<dt class="hdlist1">
<code>--filter-completed</code>
</dt>
<dd>
<p>
Only include completed TODO items.
</p>
</dd>
<dt class="hdlist1">
<code>--filter-uncompleted</code>
</dt>
<dd>
<p>
Only include uncompleted TODO items.
</p>
</dd>
</dl></div>
</div>
<div class="sect3">
<h4 id="basics_format_strings">5.1.3. Format strings</h4>
<div class="paragraph"><p>Format strings are composed of printf()-style format specifiers — ordinary
characters are copied to stdout without modification. Each specifier is
introduced by a <code>%</code> and is followed by a character which specifies the field to
print. The set of available fields depends on the item type.</p></div>
<div class="sect4">
<h5 id="_format_specifiers_for_appointments">Format specifiers for appointments</h5>
<div class="dlist"><dl>
<dt class="hdlist1">
<code>s</code>
</dt>
<dd>
<p>
Print the start time of the appointment as UNIX time stamp
</p>
</dd>
<dt class="hdlist1">
<code>S</code>
</dt>
<dd>
<p>
Print the start time of the appointment using the <code>hh:mm</code> format
</p>
</dd>
<dt class="hdlist1">
<code>d</code>
</dt>
<dd>
<p>
Print the duration of the appointment in seconds
</p>
</dd>
<dt class="hdlist1">
<code>e</code>
</dt>
<dd>
<p>
Print the end time of the appointment as UNIX time stamp
</p>
</dd>
<dt class="hdlist1">
<code>E</code>
</dt>
<dd>
<p>
Print the end time of the appointment using the <code>hh:mm</code> format
</p>
</dd>
<dt class="hdlist1">
<code>m</code>
</dt>
<dd>
<p>
Print the description of the item
</p>
</dd>
<dt class="hdlist1">
<code>n</code>
</dt>
<dd>
<p>
Print the name of the note file belonging to the item
</p>
</dd>
<dt class="hdlist1">
<code>N</code>
</dt>
<dd>
<p>
Print the note belonging to the item
</p>
</dd>
</dl></div>
</div>
<div class="sect4">
<h5 id="_format_specifiers_for_events">Format specifiers for events</h5>
<div class="dlist"><dl>
<dt class="hdlist1">
<code>m</code>
</dt>
<dd>
<p>
Print the description of the item
</p>
</dd>
<dt class="hdlist1">
<code>n</code>
</dt>
<dd>
<p>
Print the name of the note file belonging to the item
</p>
</dd>
<dt class="hdlist1">
<code>N</code>
</dt>
<dd>
<p>
Print the note belonging to the item
</p>
</dd>
</dl></div>
</div>
<div class="sect4">
<h5 id="_format_specifiers_for_todo_items">Format specifiers for todo items</h5>
<div class="dlist"><dl>
<dt class="hdlist1">
<code>p</code>
</dt>
<dd>
<p>
Print the priority of the item
</p>
</dd>
<dt class="hdlist1">
<code>m</code>
</dt>
<dd>
<p>
Print the description of the item
</p>
</dd>
<dt class="hdlist1">
<code>n</code>
</dt>
<dd>
<p>
Print the name of the note file belonging to the item
</p>
</dd>
<dt class="hdlist1">
<code>N</code>
</dt>
<dd>
<p>
Print the note belonging to the item
</p>
</dd>
</dl></div>
</div>
<div class="sect4">
<h5 id="_examples">Examples</h5>
<div class="dlist"><dl>
<dt class="hdlist1">
<code>calcurse -r7 --format-apt='- %S -> %E\n\t%m\n%N'</code>
</dt>
<dd>
<p>
Print appointments and events for the next seven days. Also, print the notes
attached to each regular appointment (simulates <code>-N</code> for appointments).
</p>
</dd>
<dt class="hdlist1">
<code>calcurse -r7 --format-apt=' - %m (%S to %E)\n' --format-recur-apt=' - %m (%S to %E)\n'</code>
</dt>
<dd>
<p>
Print appointments and events for the next seven days and use a custom format
for (recurrent) appointments: ` - Some appointment (18:30 to 21:30)`.
</p>
</dd>
<dt class="hdlist1">
<code>calcurse -t --format-todo '(%p) %m\n'</code>
</dt>
<dd>
<p>
List all todo items and put parentheses around the priority specifiers.
</p>
</dd>
</dl></div>
</div>
<div class="sect4">
<h5 id="_extended_format_specifiers">Extended format specifiers</h5>
<div class="paragraph"><p>Extended format specifiers can be used if you want to specify advanced
formatting options. Extended specifiers are introduced by <code>%(</code> and are
terminated by a closing parenthesis (<code>)</code>). The following list includes all
short specifiers and corresponding long options:</p></div>
<div class="ulist"><ul>
<li>
<p>
<code>s</code>: <code>(start)</code>
</p>
</li>
<li>
<p>
<code>S</code>: <code>(start:epoch)</code>
</p>
</li>
<li>
<p>
<code>e</code>: <code>(end)</code>
</p>
</li>
<li>
<p>
<code>E</code>: <code>(end:epoch)</code>
</p>
</li>
<li>
<p>
<code>d</code>: <code>(duration)</code>
</p>
</li>
<li>
<p>
<code>r</code>: <code>(remaining)</code>
</p>
</li>
<li>
<p>
<code>m</code>: <code>(message)</code>
</p>
</li>
<li>
<p>
<code>n</code>: <code>(noteid)</code>
</p>
</li>
<li>
<p>
<code>N</code>: <code>(note)</code>
</p>
</li>
<li>
<p>
<code>p</code>: <code>(priority)</code>
</p>
</li>
</ul></div>
<div class="paragraph"><p>The <code>(start)</code> and <code>(end)</code> specifiers support strftime()-style extended
formatting options that can be used for fine-grained formatting. Additionally,
the special formats <code>epoch</code> (which is equivalent to <code>(start:%s)</code> or <code>(end:%s)</code>)
and <code>default</code> (which is mostly equivalent to <code>(start:%H:%M)</code> or <code>(end:%H:%M)</code>
but displays <code>..:..</code> if the item doesn’t start/end at the current day) are
supported.</p></div>
<div class="paragraph"><p>The <code>(remaining)</code> and <code>(duration)</code> specifiers support a subset of the
strftime()-style formatting options, along with two extra qualifiers.
The supported options are <code>%d</code>, <code>%H</code>, <code>%M</code> and <code>%S</code>, and by default each
of these is zero-padded to two decimal places. To avoid the
zero-padding, add <code>-</code> before the formatting option (for example, <code>%-d</code>).
Additionally, the <code>E</code> option will display the total number of time units
until the appointment, rather than showing the remaining number of time
units modulo the next larger time unit. For example, an appointment in
50 hours will show as 02:00 with the formatting string <code>%H:%M</code>, but will
show 50:00 with the formatting string <code>%EH:%M</code>. Note that if you are
combining the <code>-</code> and <code>E</code> options, the <code>-</code> must come first. The default
format for the <code>(remaining)</code> specifier is <code>%EH:%M</code>.</p></div>
</div>
</div>
<div class="sect3">
<h4 id="basics_invocation_variable">5.1.4. Environment variable for i18n</h4>
<div class="paragraph"><p><code>calcurse</code> can be compiled with native language support (see
<a href="#install_requirements_gettext">gettext library</a>). Thus, if you wish to have
messages displayed into your native language, first make sure it is available
by looking at the <code>po/LINGUAS</code> file. This file indicates the set of available
languages by showing the two-letters corresponding code (for exemple, <strong>fr</strong>
stands for french). If you do not find your language, it would be greatly
appreciated if you could help translating <code>calcurse</code> (see the <a href="#contribute">How to contribute?</a> section).</p></div>
<div class="paragraph"><p>If your language is available, run <code>calcurse</code> with the following command:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>$ LC_ALL=fr_FR calcurse</code></pre>
</div></div>
<div class="olist lowerroman"><ol class="lowerroman">
<li>
<p>
where <strong>fr_FR</strong> is the locale name in this exemple, but should be replaced by
the locale corresponding to the desired language.
</p>
</li>
</ol></div>
<div class="paragraph"><p>You should also specify the charset to be used, because in some cases the
accents and such are not displayed correctly. This charset is indicated at the
beginning of the po file corresponding to the desired language. For instance,
you can see in the fr.po file that it uses the iso-8859-1 charset, so you could
run <code>calcurse</code> using the following command:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>$ LC_ALL=fr_FR.ISO8859-1 calcurse</code></pre>
</div></div>
</div>
<div class="sect3">
<h4 id="_other_environment_variables">5.1.5. Other environment variables</h4>
<div class="paragraph"><p>The following environment variables affect the way <code>calcurse</code> operates:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<code>VISUAL</code>
</dt>
<dd>
<p>
Specifies the external editor to use for writing notes.
</p>
</dd>
<dt class="hdlist1">
<code>EDITOR</code>
</dt>
<dd>
<p>
If the <code>VISUAL</code> environment variable is not set, then <code>EDITOR</code> will be used
as the default external editor. If none of those variables are set, then
<code>/usr/bin/vi</code> is used instead.
</p>
</dd>
<dt class="hdlist1">
<code>PAGER</code>
</dt>
<dd>
<p>
Specifies the default viewer to be used for reading notes. If this variable
is not set, then <code>/usr/bin/less</code> is used.
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect2">
<h3 id="_user_interface">5.2. User interface</h3>
<div class="sect3">
<h4 id="_non_interactive_mode">5.2.1. Non-interactive mode</h4>
<div class="paragraph"><p>When called with at least one of the following arguments: <code>-a</code>, <code>-d</code>, <code>-h</code>,
<code>-n</code>, <code>-t</code>, <code>-v</code>, <code>-x</code>, <code>calcurse</code> is started in non-interactive mode. This
means the desired information will be displayed, and after that, <code>calcurse</code>
simply quits and you are driven back to the shell prompt.</p></div>
<div class="paragraph"><p>That way, one can add a line such as <code>calcurse --todo --appointment</code> in its
init config file to display at logon the list of tasks and appointments
scheduled for the current day.</p></div>
</div>
<div class="sect3">
<h4 id="basics_interface_interactive">5.2.2. Interactive mode</h4>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="./images/icons/note.png" alt="Note" />
</td>
<td class="content">Key bindings that are indicated in this manual correspond to the default
ones, defined when <code>calcurse</code> is launched for the first time. If those
key bindings do not suit user’s needs, it is possible to change them
within the keys configuration menu (see <a href="#options_keys">key bindings</a>).</td>
</tr></table>
</div>
<div class="paragraph"><p>When called without any argument or only with the <code>-c</code> option, <code>calcurse</code> is
started in interactive mode. In this mode, you are shown an interface
containing three different panels which you can browse using the <code>TAB</code> key,
plus a notification bar and a status bar (see figure below).</p></div>
<div class="listingblock">
<div class="content">
<pre><code> appointment panel---. .---calendar panel
| |
v v
+------------------------------------++----------------------------+
| Appointments || Calendar |
|------------------------------------||----------------------------|
| (|) April 6, 2006 || April 2006 |
| ||Mon Tue Wed Thu Fri Sat Sun |
| || 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 |
| || |
| |+----------------------------+
| |+----------------------------+
| || ToDo | todo
| ||----------------------------| panel
| || | |
| || | |
| || |<--.
| || |
+------------------------------------++----------------------------+
|---[ Mon 2006-11-22 | 10:11:43 ]---(apts)----> 01:20 :: lunch <---|<--.
+------------------------------------------------------------------+ notify-bar
| ? Help R Redraw H/L -/+1 Day G GoTo C Config |
| Q Quit S Save J/K -/+1 Week Tab Chg View |<-.
+------------------------------------------------------------------+ |
|
status bar</code></pre>
</div></div>
<div class="paragraph"><p>The first panel represents a calendar which allows to highlight a particular
day, the second one contains the list of the events and appointments on that
day, and the last one contains a list of tasks to do but which are not assigned
to any specific day.</p></div>
<div class="paragraph"><p>Depending on the selected view, the calendar could either display a monthly
(default as shown in previous figure) or weekly view. The weekly view would
look like the following:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>+------------------------------------+
| Calendar |
|----------------------------(# 13)--|
| Mon Tue Wed Thu Fri Sat Sun |
| 29 30 31 01 02 03 04 |
| <----+-- slice 1: 00:00 to 04:00 AM
| -- -- -- -- -- -- |
| <----+-- slice 2: 04:00 to 08:00 AM
| -- -- -- -- -- -- |
| <----+-- slice 3: 08:00 to 12:00 AM
| - -- -- -- -- -- -- - <-+-- midday
| <----+-- slice 4: 12:00 to 04:00 PM
| -- -- -- -- -- -- |
| <----+-- slice 5: 04:00 to 08:00 PM
| -- -- -- -- -- -- |
| <----+-- slice 6: 08:00 to 12:00 PM
+------------------------------------+</code></pre>
</div></div>
<div class="paragraph"><p>The current week number is displayed on the top-right side of the panel (<strong># 13</strong>
meaning it is the 13th week of the year in the above example). The seven days
of the current week are displayed in column. Each day is divided into slices of
4 hours each (6 slices in total, see figure above). A slice will appear in a
different color if an appointment falls into the corresponding time-slot.</p></div>
<div class="paragraph"><p>In the appointment panel, one can notice the <strong><code>(|)</code></strong> sign just in front of the
date. This indicates the current phase of the moon. Depending on which is the
current phase, the following signs can be seen:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
` |) `
</dt>
<dd>
<p>
first quarter
</p>
</dd>
<dt class="hdlist1">
` (|) `
</dt>
<dd>
<p>
full moon
</p>
</dd>
<dt class="hdlist1">
` (| `
</dt>
<dd>
<p>
last quarter
</p>
</dd>
<dt class="hdlist1">
` | `
</dt>
<dd>
<p>
new moon
</p>
</dd>
<dt class="hdlist1">
no sign
</dt>
<dd>
<p>
Phase of the moon does not correspond to any of the above ones.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>At the very bottom of the screen there is a status bar, which indicates the
possible actions and the corresponding keystrokes.</p></div>
<div class="paragraph"><p>Just above this status bar is the notify-bar, which indicates from left to
right : the current date, the current time, the calendar file currently in use
(apts on the above example, which is the default calendar file, see the
following section), and the next appointment within the upcoming 24 hours. Here
it says that it will be lunch time in one hour and twenty minutes.</p></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="./images/icons/note.png" alt="Note" />
</td>
<td class="content">Some actions, such as editing or adding an item, require to type in some
text. This is done with the help of the built-in input line editor.</td>
</tr></table>
</div>
<div class="paragraph"><p>Within this editor, if a line is longer than the screen width, a <code>></code>, <code>*</code>, or
<code><</code> character is displayed in the last column indicating that there are more
character after, before and after, or before the current position,
respectively. The line is scrolled horizontally as necessary.</p></div>
<div class="paragraph"><p>Moreover, some editing commands are bound to particular control characters.
Hereafter are indicated the available editing commands (<code>^</code> stands for the
control key):</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<code>^a</code>
</dt>
<dd>
<p>
moves the cursor to the beginning of the input line
</p>
</dd>
<dt class="hdlist1">
<code>^b</code>
</dt>
<dd>
<p>
moves the cursor backward
</p>
</dd>
<dt class="hdlist1">
<code>^d</code>
</dt>
<dd>
<p>
deletes one character forward
</p>
</dd>
<dt class="hdlist1">
<code>^e</code>
</dt>
<dd>
<p>
moves the cursor to the end of the input line
</p>
</dd>
<dt class="hdlist1">
<code>^f</code>
</dt>
<dd>
<p>
moves the cursor forward
</p>
</dd>
<dt class="hdlist1">
<code>^h</code>
</dt>
<dd>
<p>
deletes one character backward
</p>
</dd>
<dt class="hdlist1">
<code>^k</code>
</dt>
<dd>
<p>
deletes the input from the cursor to the end of the line
</p>
</dd>
<dt class="hdlist1">
<code>^w</code>
</dt>
<dd>
<p>
deletes backward to the beginning of the current word
</p>
</dd>
<dt class="hdlist1">
<code>ESCAPE</code>
</dt>
<dd>
<p>
cancels the editing
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect2">
<h3 id="basics_daemon">5.3. Background mode</h3>
<div class="paragraph"><p>When the daemon mode is enabled in the notification configuration menu (see
<a href="#options_notify">Notify-bar settings</a>), <code>calcurse</code> will stay in background
when the user interface is not running. In background mode, <code>calcurse</code> checks
for upcoming appointments and runs the user-defined notification command when
necessary. When the user interface is started again, the daemon automatically
stops.</p></div>
<div class="paragraph"><p>‘calcurse` background activity can be logged (set the <code>daemon.log</code> variable in
the notification configuration <a href="#options_notify">menu</a>), and in that case,
information about the daemon start and stop time, reminders’ command launch
time, signals received… will be written in the <code>daemon.log</code> file (see section
<a href="#basics_files">files</a>).</p></div>
<div class="paragraph"><p>Using the <code>--status</code> command line option (see section
<a href="#basics_invocation_commandline">Command line arguments</a>), one can know if
<code>calcurse</code> is currently running in background or not. If the daemon is
running, a message like the following one will be displayed (the pid of the
daemon process will be shown):</p></div>
<div class="listingblock">
<div class="content">
<pre><code>calcurse is running in background (pid 14536)</code></pre>
</div></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="./images/icons/note.png" alt="Note" />
</td>
<td class="content">To stop the daemon, just send the <code>TERM</code> signal to it, using a command
such as: <code>kill daemon_pid</code>, where <strong>daemon_pid</strong> is the process id of the
daemon (14536 in the above example).</td>
</tr></table>
</div>
</div>
<div class="sect2">
<h3 id="basics_files">5.4. calcurse files</h3>
<div class="paragraph"><p>The following structure is created in your <code>$HOME</code> directory (or in the
directory you specified with the -D option) the first time <code>calcurse</code> is run
:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>$HOME/.calcurse/
|___notes/
|___conf
|___keys
|___apts
|___todo</code></pre>
</div></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<code>notes/</code>
</dt>
<dd>
<p>
this subdirectory contains descriptions of the notes which are attached to
appointments, events or todos. Since the file name of each note file is a
SHA1 hash of the note itself, multiple items can share the same note file.
calcurse provides a garbage collector (see the <code>-g</code> command line parameter)
that can be used to remove note files which are no longer linked to any item.
</p>
</dd>
<dt class="hdlist1">
<code>conf</code>
</dt>
<dd>
<p>
this file contains the user configuration
</p>
</dd>
<dt class="hdlist1">
<code>keys</code>
</dt>
<dd>
<p>
this file contains the user-defined key bindings
</p>
</dd>
<dt class="hdlist1">
<code>apts</code>
</dt>
<dd>
<p>
this file contains all of the events and user’s appointments
</p>
</dd>
<dt class="hdlist1">
<code>todo</code>
</dt>
<dd>
<p>
this file contains the todo list
</p>
</dd>
</dl></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="./images/icons/note.png" alt="Note" />
</td>
<td class="content">If the logging of calcurse daemon activity was set in the notification
configuration menu, the extra file <code>daemon.log</code> will appear in calcurse
data directory. This file contains logs about calcurse activity when
running in background.</td>
</tr></table>
</div>
</div>
<div class="sect2">
<h3 id="_import_export_capabilities">5.5. Import/Export capabilities</h3>
<div class="paragraph"><p>The import and export capabilities offered by <code>calcurse</code> are described below.</p></div>
<div class="sect3">
<h4 id="_import">5.5.1. Import</h4>
<div class="paragraph"><p>Data in icalendar format as described in the rfc2445 specification (see
<a href="#links_others">links</a> section below) can be imported into calcurse. Calcurse
ical parser is based on version 2.0 of this specification, but for now on, only
a subset of it is supported.</p></div>
<div class="paragraph"><p>The following icalendar properties are handled by calcurse:</p></div>
<div class="ulist"><ul>
<li>
<p>
<code>VTODO</code> items: "PRIORITY", "VALARM", "SUMMARY", "DESCRIPTION"
</p>
</li>
<li>
<p>
<code>VEVENT</code> items: "DTSTART", "DTEND", "DURATION", "RRULE", "EXDATE", "VALARM",
"SUMMARY", "DESCRIPTION"
</p>
</li>
</ul></div>
<div class="paragraph"><p>The icalendar <code>DESCRIPTION</code> property will be converted into calcurse format by
adding a note to the item. If a "VALARM" property is found, the item will be
flagged as important and the user will get a notification (this is only
applicable to appointments).</p></div>
<div class="paragraph"><p>Here are the properties that are not implemented:</p></div>
<div class="ulist"><ul>
<li>
<p>
negative time durations are not taken into account (item is skipped)
</p>
</li>
<li>
<p>
some recurence frequences are not recognize: "SECONDLY" / "MINUTELY" /
"HOURLY"
</p>
</li>
<li>
<p>
some recurrence keywords are not recognized (all those starting with <code>BY</code>):
"BYSECOND" / "BYMINUTE" / "BYHOUR" / "BYDAY" / "BYMONTHDAY" / "BYYEARDAY" /
"BYWEEKNO" / "BYMONTH" / "BYSETPOS" plus "WKST"
</p>
</li>
<li>
<p>
the recurrence exception keyword "EXRULE" is not recognized
</p>
</li>
<li>
<p>
timezones are not taken into account
</p>
</li>
</ul></div>
</div>
<div class="sect3">
<h4 id="_export">5.5.2. Export</h4>
<div class="paragraph"><p>Two possible export formats are available: <code>ical</code> and <code>pcal</code> (see section
<a href="#links_others">Links</a> below to find out about those formats).</p></div>
</div>
</div>
<div class="sect2">
<h3 id="_online_help">5.6. Online help</h3>
<div class="paragraph"><p>At any time, the built-in help system can be invoked by pressing the <code>?</code> key.
By default, it shows an introduction to the help system in an external pager.
You need to exit the pager in order to get back to calcurse (pressing <code>q</code>
should almost always work). The default pager can be changed by setting the
PAGER environment variable.</p></div>
<div class="paragraph"><p>If you want to display help on a specific feature or key binding, type <code>:help
<feature></code> (e.g. <code>:help add</code>) or <code>:help <key></code> (e.g. <code>:help ^A</code>) on the main
screen.</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_options">6. Options</h2>
<div class="sectionbody">
<div class="paragraph"><p>All of the <code>calcurse</code> parameters are configurable from the Configuration menu
available when pressing <code>C</code>. You are then driven to a submenu with five
possible choices : pressing <code>C</code> again will lead you to the Color scheme
configuration, pressing <code>L</code> allows you to choose the layout of the main
<code>calcurse</code> screen (in other words, where to put the three different panels on
screen), pressing <code>G</code> permits you to choose between different general options,
pressing <code>K</code> opens the key bindings configuration menu, and last you can modify
the notify-bar settings by pressing <code>N</code>.</p></div>
<div class="sect2">
<h3 id="options_general">6.1. General options</h3>
<div class="paragraph"><p>These options control <code>calcurse</code> general behavior, as described below:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<code>appearance.compactpanels</code> (default: <strong>no</strong>)
</dt>
<dd>
<p>
In compact panels mode, all captions are removed from panels.
</p>
</dd>
<dt class="hdlist1">
<code>appearance.defaultpanel</code> (default: <strong>calendar</strong>)
</dt>
<dd>
<p>
This can be used to specify the panel to be selected on startup.
</p>
</dd>
<dt class="hdlist1">
<code>general.autosave</code> (default: <strong>yes</strong>)
</dt>
<dd>
<p>
This option allows to automatically save the user’s data (if set to <strong>yes</strong>)
when quitting. <p class="rq"><span class="valorise">warning:</span> No data
will be automatically saved if <code>general.autosave</code> is set to <strong>no</strong>. This means
the user must press <code>S</code> (for saving) in order to retrieve its modifications.
</p>
</dd>
<dt class="hdlist1">
<code>general.autogc</code> (default: <strong>no</strong>)
</dt>
<dd>
<p>
Automatically run the garbage collector for note files when quitting.
</p>
</dd>
<dt class="hdlist1">
<code>general.periodicsave</code> (default: <strong>0</strong>)
</dt>
<dd>
<p>
If different from <code>0</code>, user’s data will be automatically saved every
<strong>general.periodicsave</strong> minutes. When an automatic save is performed, two
asterisks (i.e. <code>**</code>) will appear on the top right-hand side of the screen).
</p>
</dd>
<dt class="hdlist1">
<code>general.confirmquit</code> (default: <strong>yes</strong>)
</dt>
<dd>
<p>
If set to <strong>yes</strong>, confirmation is required before quitting, otherwise pressing
<code>Q</code> will cause <code>calcurse</code> to quit without prompting for user confirmation.
</p>
</dd>
<dt class="hdlist1">
<code>general.confirmdelete</code> (default: <strong>yes</strong>)
</dt>
<dd>
<p>
If this option is set to <strong>yes</strong>, pressing <code>D</code> for deleting an item (either a
<strong>todo</strong>, <strong>appointment</strong>, or <strong>event</strong>), will lead to a prompt asking for user
confirmation before removing the selected item from the list. Otherwise, no
confirmation will be needed before deleting the item.
</p>
</dd>
<dt class="hdlist1">
<code>general.systemdialogs</code> (default: <strong>yes</strong>)
</dt>
<dd>
<p>
Setting this option to <strong>no</strong> will result in skipping the system dialogs
related to the saving and loading of data. This can be useful to speed up
the input/output processes.
</p>
</dd>
<dt class="hdlist1">
<code>general.progressbar</code> (default: <strong>yes</strong>)
</dt>
<dd>
<p>
If set to <strong>no</strong>, this will cause the disappearing of the progress bar which is
usually shown when saving data to file. If set to <strong>yes</strong>, this bar will be
displayed, together with the name of the file being saved (see section
<a href="#basics_files">calcurse files</a>).
</p>
</dd>
<dt class="hdlist1">
<code>appearance.calendarview</code> (default: <strong>0</strong>)
</dt>
<dd>
<p>
If set to <code>0</code>, the monthly calendar view will be displayed by default
otherwise it is the weekly view that will be displayed.
</p>
</dd>
<dt class="hdlist1">
<code>general.firstdayofweek</code> (default: <strong>monday</strong>)
</dt>
<dd>
<p>
One can choose between Monday and Sunday as the first day of the week. If
<code>general.firstdayofweek</code> is set to <strong>monday</strong>, Monday will be first in the
calendar view. Otherwise, Sunday will be the first day of the week.
</p>
</dd>
<dt class="hdlist1">
<code>format.outputdate</code> (default: <strong>%D</strong>)
</dt>
<dd>
<p>
This option indicates the format to be used when displaying dates in
non-interactive mode. Using the default values, dates are displayed the
following way: <strong>mm/dd/aa</strong>. You can see all of the possible formats by typing
<code>man 3 strftime</code> inside a terminal.
</p>
</dd>
<dt class="hdlist1">
<code>format.inputdate</code> (default: <strong>1</strong>)
</dt>
<dd>
<p>
This option indicates the format that will be used to enter dates in
interactive mode. Four choices are available:
</p>
<div class="olist arabic"><ol class="arabic">
<li>
<p>
mm/dd/yyyy
</p>
</li>
<li>
<p>
dd/mm/yyyy
</p>
</li>
<li>
<p>
yyyy/mm/dd
</p>
</li>
<li>
<p>
yyyy-mm-dd
</p>
</li>
</ol></div>
</dd>
</dl></div>
</div>
<div class="sect2">
<h3 id="options_keys">6.2. Key bindings</h3>
<div class="paragraph"><p>One can define ones own key bindings within the <code>Keys</code> configuration menu. The
default keys look like the one used by the <code>vim</code> editor, especially the
displacement keys. Anyway, within this configuration menu, users can redefine
all of the keys available from within calcurse’s user interface.</p></div>
<div class="paragraph"><p>To define new key bindings, first highlight the action to which it will apply.
Then, delete the actual key binding if necessary, and add a new one. You will
then be asked to press the key corresponding to the new binding. It is possible
to define more than one key binding for a single action.</p></div>
<div class="paragraph"><p>An automatic check is performed to see if the new key binding is not already
set for another action. In that case, you will be asked to choose a different
one. Another check is done when exiting from this menu, to make sure all
possible actions have a key associated with it.</p></div>
<div class="paragraph"><p>The following keys can be used to define bindings:</p></div>
<div class="ulist"><ul>
<li>
<p>
lower-case, upper-case letters and numbers, such as <code>a</code>, <code>Z</code>, <code>0</code>
</p>
</li>
<li>
<p>
CONTROL-key followed by one of the above letters
</p>
</li>
<li>
<p>
escape, horizontal tab, and space keys
</p>
</li>
<li>
<p>
arrow keys (up, down, left, and right)
</p>
</li>
<li>
<p>
<code>HOME</code> and <code>END</code> keys
</p>
</li>
</ul></div>
<div class="paragraph"><p>While inside the key configuration menu, an online help is available for each
one of the available actions. This help briefly describes what the highlighted
action is used for.</p></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="./images/icons/note.png" alt="Note" />
</td>
<td class="content">As of calcurse 3.0.0, displacement commands can be preceded by an
optional number to repeat the command. For example, <code>10k</code> will move the
cursor ten weeks forwards if you use default key bindings.</td>
</tr></table>
</div>
</div>
<div class="sect2">
<h3 id="_color_themes">6.3. Color themes</h3>
<div class="paragraph"><p><code>calcurse</code> color theme can be customized to suit user’s needs. To change the
default theme, the configuration page displays possible choices for foreground
and background colors. Using arrows or calcurse displacement keys to move, and
<code>X</code> or space to select a color, user can preview the theme which will be
applied. It is possible to keep the terminal’s default colors by selecting the
corresponding choice in the list.</p></div>
<div class="paragraph"><p>The chosen color theme will then be applied to the panel borders, to the
titles, to the keystrokes, and to general informations displayed inside status
bar. A black and white theme is also available, in order to support non-color
terminals.</p></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="./images/icons/note.png" alt="Note" />
</td>
<td class="content">Depending on your terminal type and on the value of the <code>$TERM</code>
environment variable, color could or could not be supported. An error
message will appear if you try to change colors whereas your terminal
does not support this feature. If you do know your terminal supports
colors but could not get <code>calcurse</code> to display them, try to set your
<code>$TERM</code> variable to another value (such as <strong>xterm-xfree86</strong> for instance).</td>
</tr></table>
</div>
</div>
<div class="sect2">
<h3 id="_layout_configuration">6.4. Layout configuration</h3>
<div class="paragraph"><p>The layout corresponds to the position of the panels inside <code>calcurse</code> screen.
The default layout makes the calendar panel to be displayed on the top-right
corner of the terminal, the todo panel on the bottom-right corner, while the
appointment panel is displayed on the left hand-side of the screen (see the
figure in section <a href="#basics_interface_interactive">Interactive mode</a> for an
example of the default layout). By choosing another layout in the
configuration screen, user can customize <code>calcurse</code> appearance to best suit his
needs by placing the different panels where needed.</p></div>
<div class="paragraph"><p>The following option is used to modify the layout configuration:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<code>appearance.layout</code> (default: <strong>0</strong>)
</dt>
<dd>
<p>
Eight different layouts are to be chosen from (see layout configuration
screen for the description of the available layouts).
</p>
</dd>
</dl></div>
</div>
<div class="sect2">
<h3 id="_sidebar_configuration">6.5. Sidebar configuration</h3>
<div class="paragraph"><p>The sidebar is the part of the screen which contains two panels: the calendar
and, depending on the chosen layout, either the todo list or the appointment
list.</p></div>
<div class="paragraph"><p>The following option is used to change the width of the sidebar:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<code>appearance.sidebarwidth</code> (default: <strong>0</strong>)
</dt>
<dd>
<p>
Width (in percentage, 0 being the minimum width) of the side bar.
</p>
</dd>
</dl></div>
</div>
<div class="sect2">
<h3 id="options_notify">6.6. Notify-bar settings</h3>
<div class="paragraph"><p>The following options are used to modify the notify-bar behavior:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<code>appearance.notifybar</code> (default: <strong>yes</strong>)
</dt>
<dd>
<p>
This option indicates if you want the notify-bar to be displayed or not.
</p>
</dd>
<dt class="hdlist1">
<code>format.notifydate</code> (default: <strong>%a %F</strong>)
</dt>
<dd>
<p>
With this option, you can specify the format to be used to display the
current date inside the notification bar. You can see all of the possible
formats by typing <code>man 3 strftime</code> inside a terminal.
</p>
</dd>
<dt class="hdlist1">
<code>format.notifytime</code> (default: <strong>%T</strong>)
</dt>
<dd>
<p>
With this option, you can specify the format to be used to display the
current time inside the notification bar. You can see all of the possible
formats by typing <code>man 3 strftime</code> inside a terminal.
</p>
</dd>
<dt class="hdlist1">
<code>notification.warning</code> (default: <strong>300</strong>)
</dt>
<dd>
<p>
When there is an appointment which is flagged as <code>important</code> within the next
<code>notification.warning</code> seconds, the display of that appointment inside the
notify-bar starts to blink. Moreover, the command defined by the
<code>notification.command</code> option will be launched. That way, the user is warned
and knows there will be soon an upcoming appointment.
</p>
</dd>
<dt class="hdlist1">
<code>notification.command</code> (default: <strong>printf <em>\a</em></strong>)
</dt>
<dd>
<p>
This option indicates which command is to be launched when there is an
upcoming appointment flagged as <code>important</code>. This command will be passed to
the user’s shell which will interpret it. To know what shell must be used,
the content of the <code>$SHELL</code> environment variable is used. If this variable is
not set, <code>/bin/sh</code> is used instead.
</p>
<div class="exampleblock">
<div class="content">
<div class="paragraph"><p>Say the <code>mail</code> command is available on the user’s system, one can use the
following command to get notified by mail of an upcoming appointment (the
appointment description will also be mentioned in the mail body):</p></div>
<div class="listingblock">
<div class="content">
<pre><code>$ calcurse --next | mail -s "[calcurse] upcoming appointment!" user@host.com</code></pre>
</div></div>
</div></div>
</dd>
<dt class="hdlist1">
<code>notification.notifyall</code> (default: <strong>no</strong>)
</dt>
<dd>
<p>
Invert the sense of flagging an appointment as <code>important</code>. If this is
enabled, all appointments will be notified - except for flagged ones.
</p>
</dd>
<dt class="hdlist1">
<code>daemon.enable</code> (default: <strong>no</strong>)
</dt>
<dd>
<p>
If set to yes, daemon mode will be enabled, meaning <code>calcurse</code> will run into
background when the user’s interface is exited. This will allow the
notifications to be launched even when the interface is not running. More
details can be found in section <a href="#basics_daemon">Background mode</a>.
</p>
</dd>
<dt class="hdlist1">
<code>daemon.log</code> (default: <strong>no</strong>)
</dt>
<dd>
<p>
If set to yes, <code>calcurse</code> daemon activity will be logged (see section
<a href="#basics_files">files</a>).
</p>
</dd>
</dl></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_known_bugs">7. Known bugs</h2>
<div class="sectionbody">
<div class="paragraph"><p>Incorrect highlighting of items appear when using calcurse black and white
theme together with a <code>$TERM</code> variable set to <strong>xterm-color</strong>. To fix this bug,
and as advised by Thomas E. Dickey (<code>xterm</code> maintainer), <strong>xterm-xfree86</strong> should
be used instead of <strong>xterm-color</strong> to set the <code>$TERM</code> variable:</p></div>
<div class="quoteblock">
<div class="content">
<div class="paragraph"><p>"The xterm-color value for $TERM is a bad choice for XFree86 xterm because it
is commonly used for a <code>terminfo</code> entry which happens to not support bce. Use
the xterm-xfree86 entry which is distributed with XFree86 xterm (or the similar
one distributed with ncurses)."</p></div>
</div>
<div class="attribution">
</div></div>
</div>
</div>
<div class="sect1">
<h2 id="bugs">8. Reporting bugs and feedback</h2>
<div class="sectionbody">
<div class="paragraph"><p>Please send bug reports and feedback to: <code>misc .at. calcurse .dot. org</code>.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="contribute">9. How to contribute?</h2>
<div class="sectionbody">
<div class="paragraph"><p>If you would like to contribute to the project, you can first send your
feedback on what you like or dislike, and if there are features you miss in
<code>calcurse</code>. For now on, possible contributions concern the translation of
<code>calcurse</code> messages and documentation.</p></div>
<div class="sect2">
<h3 id="_translating_documentation">9.1. Translating documentation</h3>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="./images/icons/note.png" alt="Note" />
</td>
<td class="content">We recently dropped all translations of the manual files from the
distribution tarball. There are plan to reintroduce them in form of a
Wiki on the calcurse website. Please follow the mailing lists for
up-to-date information.</td>
</tr></table>
</div>
<div class="paragraph"><p>The <strong>doc/</strong> directory of the source package already contains translated version
of <code>calcurse</code> manual. However, if the manual is not yet available into your
native language, it would be appreciated if you could help translating it.</p></div>
<div class="paragraph"><p>To do so, just copy one of the existing manual file to <code>manual_XX.html</code>, where
<strong>XX</strong> identifies your language. Then translate this newly created file and send
it to the author (see <a href="#bugs">Reporting bugs and feeback</a>), so that it can be
included in the next <code>calcurse</code> release.</p></div>
</div>
<div class="sect2">
<h3 id="_calcurse_i18n">9.2. calcurse i18n</h3>
<div class="paragraph"><p>As already mentioned, <code>gettext</code> utilities are used by <code>calcurse</code> to produce
multi-lingual messages. We are currently using
<a href="http://www.transifex.net/">Transifex</a> to manage those translations.</p></div>
<div class="paragraph"><p>This section provides informations about how to translate those messages into
your native language. However, this howto is deliberately incomplete, focusing
on working with <code>gettext</code> for <code>calcurse</code> specifically. For more comprehensive
informations or to grasp the Big Picture of Native Language Support, you should
refer to the <code>GNU gettext</code> manual at:
<a href="http://www.gnu.org/software/gettext/manual/">http://www.gnu.org/software/gettext/manual/</a></p></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="./images/icons/important.png" alt="Important" />
</td>
<td class="content">Since we switched to Transifex, editing <strong>po</strong> files is not necessary
anymore as Transifex provides a user-friendly, intuitive web
interface for translators. Knowledge of <code>gettext</code> and the <strong>po</strong>
format is still useful for those of you who prefer the command line
and local editing. If you want to use the web UI to edit the
translation strings, you can skip over to <a href="#transifex_webui">Using the Transifex web UI</a> tough.</td>
</tr></table>
</div>
<div class="paragraph"><p>Basically, three different people get involved in the translation chain:
coders, language coordinator, and translators. After a quick overview of how
things work, the translator tasks will be described hereafter.</p></div>
<div class="sect3">
<h4 id="_overview_2">9.2.1. Overview</h4>
<div class="paragraph"><p>To be able to display texts in the native language of the user, two steps are
required: <strong>internationalization</strong> (i18n) and <strong>localization</strong> (l10n).</p></div>
<div class="paragraph"><p>i18n is about making <code>calcurse</code> support multiple languages. It is performed by
coders, who will mark translatable texts and provide a way to display them
translated at runtime.</p></div>
<div class="paragraph"><p>l10n is about making the i18n’ed <code>calcurse</code> adapt to the specific language of
the user, ie translating the strings previously marked by the developers, and
setting the environment correctly for <code>calcurse</code> to use the result of this
translation.</p></div>
<div class="paragraph"><p>So, translatable strings are first marked by the coders within the <code>C</code> source
files, then gathered in a template file (<strong>calcurse.pot</strong> - the <strong>pot</strong> extension
meaning <strong>portable object template</strong>). The content of this template file is then
merged with the translation files for each language (<strong>fr.po</strong> for French, for
instance - with <strong>po</strong> standing for <strong>portable object</strong>, ie meant to be read and
edited by humans). A given translation team will take this file, translate its
strings, and send it back to the developers. At compilation time, a binary
version of this file (for efficiency reasons) will be produced (<strong>fr.mo</strong> - <strong>mo</strong>
stands for <strong>machine object</strong>, i.e. meant to be read by programs), and then
installed. Then <code>calcurse</code> will use this file at runtime, translating the
strings according to the locale settings of the user.</p></div>
</div>
<div class="sect3">
<h4 id="_translator_tasks">9.2.2. Translator tasks</h4>
<div class="paragraph"><p>Suppose someone wants to initiate the translation of a new language. Here are
the steps to follow:</p></div>
<div class="ulist"><ul>
<li>
<p>
First, find out what the locale name is. For instance, for french, it is
<code>fr_FR</code>, or simply <code>fr</code>. This is the value the user will have to put in his
<code>LC_ALL</code> environment variable for software to be translated (see
<a href="#basics_invocation_variable">Environment variable for i18n</a>).
</p>
</li>
<li>
<p>
Then, go into the <strong>po/</strong> directory, and create a new po-file
from the template file using the following command: <code>msginit -i calcurse.pot
-o fr.po -l fr --no-translator</code> If you do not have <code>msginit</code> installed on
your system, simply copy the <strong>calcurse.pot</strong> file to <strong>fr.po</strong> and edit the
header by hand.
</p>
</li>
</ul></div>
<div class="paragraph"><p>Now, having this <strong>fr.po</strong> file, the translator is ready to begin.</p></div>
</div>
<div class="sect3">
<h4 id="_po_files">9.2.3. po-files</h4>
<div class="paragraph"><p>The format of the po-files is quite simple. Indeed, po-files are made of four
things:</p></div>
<div class="olist arabic"><ol class="arabic">
<li>
<p>
<strong>location lines:</strong> tells you where the strings can be seen (name of file and
line number), in case you need to see a bit of context.
</p>
</li>
<li>
<p>
<strong>msgid lines:</strong> the strings to translate.
</p>
</li>
<li>
<p>
<strong>msgstr lines:</strong> the translated strings.
</p>
</li>
<li>
<p>
<strong>lines prefixed with <code>#</code>:</strong> comments (some with a special meaning, as we will
see below).
</p>
</li>
</ol></div>
<div class="paragraph"><p>Basically, all you have to do is fill the <strong>msgstr</strong> lines with the translation
of the above <strong>msgid</strong> line.</p></div>
<div class="paragraph"><p>A few notes:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>Fuzzy strings</strong>
</dt>
<dd>
<p>
You will meet strings marked with a <code>"#, fuzzy"</code> comment. <code>calcurse</code> won’t
use the translations of such strings until you do something about them. A
string being fuzzy means either that the string has already been translated
but has since been changed in the sources of the program, or that this is a
new string for which <code>gettext</code> made a <em>wild guess</em> for the translation, based
on other strings in the file. It means you have to review the translation.
Sometimes, the original string has changed just because a typo has been
fixed. In this case, you won’t have to change anything. But sometimes, the
translation will no longer be accurate and needs to be changed. Once you are
done and happy with the translation, just remove the <code>"#, fuzzy"</code> line, and
the translation will be used again in <code>calcurse</code>.
</p>
</dd>
<dt class="hdlist1">
<strong>c-format strings and special sequences</strong>
</dt>
<dd>
<p>
Some strings have the following comment: <code>"#, c-format"</code>. This tells that
parts of the string to translate have a special meaning for the program, and
that you should leave them alone. For instance, %-sequences, like <code>"%s"</code>.
These means that <code>calcurse</code> will replace them with another string. So it is
important it remains. There are also \-sequences, like <code>\n</code> or <code>\t</code>. Leave
them, too. The former represents an end of line, the latter a tabulation.
</p>
</dd>
<dt class="hdlist1">
<strong>Translations can be wrapped</strong>
</dt>
<dd>
<p>
If lines are too long, you can just break them like this:
</p>
<div class="listingblock">
<div class="content">
<pre><code>msgid ""
"some very long line"
"another line"</code></pre>
</div></div>
</dd>
<dt class="hdlist1">
<strong>po-file header</strong>
</dt>
<dd>
<p>
At the very beginning of the po-file, the first string form a header, where
various kind of information has to be filled in. Most important one is the
charset. It should resemble
</p>
<div class="listingblock">
<div class="content">
<pre><code>"Content-Type: text/plain; charset=utf-8\n"</code></pre>
</div></div>
<div class="paragraph"><p>You should also fill in the Last-Translator field, so that potential
contributors can contact you if they want to join you in the translation team,
or have remarks/typo fixes to give about the translations. You can either just
give your name/nick, or add an email address, for exemple:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>"Last-Translator: Frederic Culot <frederic@culot.org>\n"</code></pre>
</div></div>
</dd>
<dt class="hdlist1">
<strong>Comments</strong>
</dt>
<dd>
<p>
Adding comments (lines begining with the <code>#</code> character) can be a good way to
point out problems or translation difficulties to proofreaders or other
members of your team.
</p>
</dd>
<dt class="hdlist1">
<strong>Strings size</strong>
</dt>
<dd>
<p>
<code>calcurse</code> is a curses/console program, thus it can be heavily dependant on
the terminal size (number of columns). You should think about this when
translating. Often, a string must fit into a single line (standard length is
80 characters). Don’t translate blindly, try to look where your string will
be displayed to adapt your translation.
</p>
</dd>
<dt class="hdlist1">
<strong>A few useful tools</strong>
</dt>
<dd>
<p>
The po-file format is very simple, and the file can be edited with a standard
text editor. But if you prefer, there are few specialized tools you may find
convenient for translating:
</p>
<div class="ulist"><ul>
<li>
<p>
<code>poEdit</code> (<a href="http://www.poedit.org/">http://www.poedit.org/</a>)
</p>
</li>
<li>
<p>
<code>KBabel</code> (<a href="http://i18n.kde.org/tools/kbabel/">http://i18n.kde.org/tools/kbabel/</a>)
</p>
</li>
<li>
<p>
<code>GTranslator</code> (<a href="http://gtranslator.sourceforge.net/">http://gtranslator.sourceforge.net/</a>)
</p>
</li>
<li>
<p>
<code>Emacs</code> po mode
</p>
</li>
<li>
<p>
<code>Vim</code> po mode
</p>
</li>
</ul></div>
</dd>
<dt class="hdlist1">
<strong>And finally</strong>
</dt>
<dd>
<p>
I hope you’ll have fun contributing to a more internationalized world. :) If
you have any more questions, don’t hesitate to contact us at <strong>misc .at.
calcurse .dot. org</strong>.
</p>
</dd>
</dl></div>
</div>
<div class="sect3">
<h4 id="transifex_uploading">9.2.4. Uploading to Transifex</h4>
<div class="paragraph"><p>There’s several different ways to upload a finished (or semi-finished)
translation for a new language to Transifex. The easiest way is to browse to
the <a href="http://www.transifex.net/projects/p/calcurse/teams/">Translation Teams</a> page
and request the addition of a new team.</p></div>
<div class="paragraph"><p>As soon as we accepted your request, you will be able to upload your <strong>po</strong> file
on the
<a href="http://www.transifex.net/projects/p/calcurse/resource/calcursepot/">calcurse
resource page</a> by clicking the <strong>Add translation</strong> button at the bottom.</p></div>
</div>
<div class="sect3">
<h4 id="_using_transifex_client">9.2.5. Using transifex-client</h4>
<div class="paragraph"><p>You can also use a command line client to submit translations instead of having
to use the web interface every time you want to submit an updated version. If
you have a recent version of <code>setuptools</code> installed, you can get the CLI client
by issuing the following command:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>$ easy_install -U transifex-client</code></pre>
</div></div>
<div class="paragraph"><p>Alternatively, you can get the source code of transifex-client at
<a href="http://pypi.python.org/pypi/transifex-client">http://pypi.python.org/pypi/transifex-client</a>.</p></div>
<div class="paragraph"><p>After you downloaded and installed the client, run the following commands in
the calcurse source directory to checkout the translation resources of
<strong>calcurse</strong>:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>$ tx pull -a</code></pre>
</div></div>
<div class="paragraph"><p>To submit changes back to the server, use:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>$ tx push -r calcurse.calcursepot -t -l <locale></code></pre>
</div></div>
<div class="paragraph"><p>For more details, read up on <code>transifex-client</code> usage at the
<a href="http://help.transifex.net/user-guide/client/">The Transifex Command-line Client
v0.4</a> section of the <a href="http://help.transifex.net/">Transifex documentation</a>.</p></div>
</div>
<div class="sect3">
<h4 id="transifex_webui">9.2.6. Using the Transifex web UI</h4>
<div class="paragraph"><p>As an alternative to editing <strong>po</strong> files, there is a web-based interface that
can be used to create and update translations. After having signed up and
created a new translation team (see <a href="#transifex_uploading">Uploading to Transifex</a> on how to do that), click the <strong>Add translation</strong> button at the
bottom on the
<a href="http://www.transifex.net/projects/p/calcurse/resource/calcursepot/">calcurse
resource page</a>, select the language you’d like to translate and choose
<strong>Translate Online</strong>.</p></div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_links">10. Links</h2>
<div class="sectionbody">
<div class="paragraph"><p>This section contains links and references that may be of interest to you.</p></div>
<div class="sect2">
<h3 id="_calcurse_homepage">10.1. calcurse homepage</h3>
<div class="paragraph"><p>The <code>calcurse</code> homepage can be found at <a href="http://calcurse.org">http://calcurse.org</a></p></div>
</div>
<div class="sect2">
<h3 id="_calcurse_announce_list">10.2. calcurse announce list</h3>
<div class="paragraph"><p>If you are interested in the project and want to be warned when a new release
comes out, you can subscribe to the <code>calcurse</code> announce list. In doing so, you
will receive an email as soon as a new feature appears in <code>calcurse</code>.</p></div>
<div class="paragraph"><p>To subscribe to this list, send a message to <strong>announce+subscribe .at. calcurse
.dot. org</strong> with "subscribe" in the subject field.</p></div>
</div>
<div class="sect2">
<h3 id="links_others">10.3. Other links</h3>
<div class="paragraph"><p>You may want to look at the ical format specification (rfc2445) at:
<a href="http://tools.ietf.org/html/rfc2445">http://tools.ietf.org/html/rfc2445</a></p></div>
<div class="paragraph"><p>The pcal project page can be found at: <a href="http://pcal.sourceforge.net/">http://pcal.sourceforge.net/</a></p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_thanks">11. Thanks</h2>
<div class="sectionbody">
<div class="paragraph"><p>Its time now to thank other people without whom this program would not exist!
So here is a list of contributing persons I would like to thank :</p></div>
<div class="ulist"><ul>
<li>
<p>
Alex for its patches, help and advices with <code>C</code> programming
</p>
</li>
<li>
<p>
Gwen for testing and general discussions about how to improve <code>calcurse</code>
</p>
</li>
<li>
<p>
Herbert for packaging <code>calcurse</code> for FreeBSD
</p>
</li>
<li>
<p>
Zul for packaging <code>calcurse</code> for NetBSD
</p>
</li>
<li>
<p>
Wain, Steffen and Ronald for packaging <code>calcurse</code> for Archlinux
</p>
</li>
<li>
<p>
Kevin, Ryan, and fEnIo for packaging <code>calcurse</code> for Debian and Ubuntu
</p>
</li>
<li>
<p>
Pascal for packaging <code>calcurse</code> for Slackware
</p>
</li>
<li>
<p>
Alexandre and Markus for packaging <code>calcurse</code> for Mac OsX and Darwin
</p>
</li>
<li>
<p>
Igor for packaging <code>calcurse</code> for ALT Linux
</p>
</li>
<li>
<p>
Joel for its calendar script which inspired <code>calcurse</code> calendar view
</p>
</li>
<li>
<p>
Jeremy Roon for the Dutch translation
</p>
</li>
<li>
<p>
Frédéric Culot, Toucouch, Erik Saule, Stéphane Aulery
and Baptiste Jonglez for the French translation
</p>
</li>
<li>
<p>
Michael Schulz, Chris M., Benjamin Moeller and Lukas Fleischer for the German
translation
</p>
</li>
<li>
<p>
Rafael Ferreira for the Portuguese (Brazil) translation
</p>
</li>
<li>
<p>
Aleksey Mechonoshin for the Russian translation
</p>
</li>
<li>
<p>
Jose Lopez for the Spanish translation
</p>
</li>
<li>
<p>
Tony for its patch which helped improving the recur_item_inday() function,
and for implementing the date format configuration options
</p>
</li>
<li>
<p>
Erik Saule for its patch implementing the <code>-N</code>, <code>-s</code>, <code>-S</code>, <code>-r</code> and <code>-D</code>
flags
</p>
</li>
<li>
<p>
people who write softwares I like and which inspired me, especially :
</p>
<div class="ulist"><ul>
<li>
<p>
<code>vim</code> for the displacement keys
</p>
</li>
<li>
<p>
<code>orpheus</code> and <code>abook</code> for documentation
</p>
</li>
<li>
<p>
<code>pine</code> and <code>aptitude</code> for the text user interface
</p>
</li>
<li>
<p>
<code>tmux</code> for coding style
</p>
</li>
</ul></div>
</li>
</ul></div>
<div class="paragraph"><p>And last, many many thanks to all of the <code>calcurse</code> users who sent me their
feedback.</p></div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2015-02-22 11:34:11 CET
</div>
</div>
</body>
</html>
|