/usr/share/doc/eggdrop-data/html/tcl-commands.html is in eggdrop-data 1.6.21-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!-- $Id: tcl-commands.html,v 1.74 2011/09/19 14:38:50 thommey Exp $ -->
<html>
<head>
<title>Eggdrop Documentation: Eggdrop Tcl Commands</title>
</head>
<body>
<div align="center">
<p><strong>Eggdrop Tcl Commands</strong></p>
</div>
<hr>
<p>This is an exhaustive list of all the Tcl commands added to Eggdrop.
All of the normal Tcl built-in commands are still there, of course, but
you can also use these to manipulate features of the bot. They are listed
according to category.</p>
<p>This list is accurate for Eggdrop v1.6.20. Scripts written for
v1.3/v1.4 series of Eggdrop should probably work with a few minor
modifications depending on the script. Scripts which were written for
v0.9, v1.0, v1.1 or v1.2 will probably not work without modification.
Commands which have been changed in this version of Eggdrop (or are
just new commands) are marked with an asterisk (*).</p>
<blockquote>
<ol>
<li><a href="#output">Output commands</a></li>
<li><a href="#urmc">User record manipulation commands</a></li>
<li><a href="#chancmds">Channel commands</a></li>
<li><a href="#dcccmds">DCC commands</a></li>
<li><a href="#notes">Notes module</a></li>
<li><a href="#assoc">Assoc module</a></li>
<li><a href="#compress">Compress module</a></li>
<li><a href="#filesys">Filesys module</a></li>
<li><a href="#misc">Miscellaneous commands</a></li>
<li><a href="#globvars">Global variables</a></li>
<li>
<a href="#bind">Bind</a>
<ol type="a">
<li><a href="#binda">Bind types</a></li>
<li><a href="#bindb">Return values</a></li>
</ol>
</li>
<li><a href="#control">Control procedures</a></li>
<li><a href="#tcp">TCP connections</a></li>
<li><a href="#matchchars">Match characters</a></li>
</ol>
</blockquote>
<hr>
<p><a name="output"></a>1. <strong>Output commands</strong></p>
<blockquote>
<dl>
<dt><strong><a name="cmd_putserv"></a>putserv <text> [options]</strong></dt>
<dd>
<p><strong>Description:</strong> sends text to the server, like
'.dump' (intended for direct server commands); output is
queued so that the bot won't flood itself off the server.</p>
<p><strong>Options:</strong></p>
<blockquote>
<p><strong>-next</strong>: push messages to the front of the
queue<br>
<strong>-normal</strong>: no effect</p>
</blockquote>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> server</p>
</dd>
<dt><strong><a name="cmd_puthelp"></a>puthelp <text> [options]</strong></dt>
<dd>
<p><strong>Description:</strong> sends text to the server, like
'putserv', but it uses a different queue intended for
sending messages to channels or people.</p>
<p><strong>Options:</strong></p>
<blockquote>
<p><strong>-next</strong>: push messages to the front of the
queue<br>
<strong>-normal</strong>: no effect</p>
</blockquote>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> server</p>
</dd>
<dt><strong><a name="cmd_putquick"></a>putquick <text> [options]</strong></dt>
<dd>
<p><strong>Description:</strong> sends text to the server, like
'putserv', but it uses a different (and faster) queue.</p>
<p><strong>Options:</strong></p>
<blockquote>
<p><strong>-next</strong>: push messages to the front of the
queue<br>
<strong>-normal</strong>: no effect</p>
</blockquote>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> server</p>
</dd>
<dt><strong><a name="cmd_putnow"></a>putnow <text> [-oneline]</strong></dt>
<dd>
<p><strong>Description:</strong> sends text to the server
immediately, bypassing all queues.
Use with caution, as the bot may easily flood itself off
the server.</p>
<p><strong>Options:</strong></p>
<blockquote>
<p><strong>-oneline</strong>: send text up to the first \r or \n,
discarding the rest</p>
</blockquote>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> server</p>
</dd>
<dt><strong><a name="cmd_putkick"></a>putkick <channel> <nick,nick,...>
[reason]</strong></dt>
<dd>
<p><strong>Description:</strong> sends kicks to the server and
tries to put as many nicks into one kick command as possible.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_putlog"></a>putlog <text></strong></dt>
<dd>
<p><strong>Description:</strong> sends text to the bot's
logfile, marked as 'misc' (o)</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_putcmdlog"></a>putcmdlog <text></strong></dt>
<dd>
<p><strong>Description:</strong> sends text to the bot's
logfile, marked as 'command' (c)</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_putxferlog"></a>putxferlog <text></strong></dt>
<dd>
<p><strong>Description:</strong> sends text to the bot's
logfile, marked as 'file-area' (x)</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_putloglev"></a>putloglev <level(s)> <channel>
<text></strong></dt>
<dd>
<p><strong>Description:</strong> sends text to the bot's
logfile, tagged with all of the valid levels given. Use
"*" to indicate all log levels.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_dumpfile"></a>dumpfile <nick> <filename></strong></dt>
<dd>
<p><strong>Description:</strong> dumps file from the help/text
directory to a user on IRC via msg (one line per msg). The user
has no flags, so the flag bindings won't work within the
file.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_queuesize"></a>queuesize [queue]</strong></dt>
<dd>
<p><strong>Returns:</strong> the number of messages in all queues.
If a queue is specified, only the size of this queue is returned.
Valid queues are: mode, server, help.</p>
<p><strong>Module:</strong> server</p>
</dd>
<dt><strong><a name="cmd_clearqueue"></a>clearqueue <queue></strong></dt>
<dd>
<p><strong>Description:</strong> removes all messages from a
queue. Valid arguments are: mode, server, help, or all.</p>
<p><strong>Returns:</strong> the number of deleted lines from
the specified queue.</p>
<p><strong>Module:</strong> server</p>
</dd>
</dl>
</blockquote>
<p><a name="urmc"></a>2. <strong>User record manipulation
commands</strong></p>
<blockquote>
<dl>
<dt><strong><a name="cmd_countusers"></a>countusers</strong></dt>
<dd>
<p><strong>Returns:</strong> number of users in the bot's
database</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_validuser"></a>validuser <handle></strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if a user by that name exists;
0 otherwise</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_finduser"></a>finduser <nick!user@host></strong></dt>
<dd>
<p><strong>Description:</strong> finds the user record which most
closely matches the given nick!user@host</p>
<p><strong>Returns:</strong> the handle found, or "*"
if none</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_userlist"></a>userlist [flags]</strong></dt>
<dd>
<p><strong>Returns:</strong> a list of users on the bot. You
can use the flag matching system here
([global]{&/|}[chan]{&/|}[bot]). '&' specifies
"and"; '|' specifies "or".</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_passwdok"></a>passwdok <handle> <pass></strong></dt>
<dd>
<p><strong>Description:</strong> checks the password given against
the user's password. Check against the password ""
(a blank string) or "-" to find out if a user has no
password set.</p>
<p><strong>Returns:</strong> 1 if the password matches for that
user; 0 otherwise</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_getuser"></a>getuser <handle> <entry-type>
[extra info]</strong></dt>
<dd>
<p><strong>Description:</strong> an interface to the new generic
userfile support. Valid entry types are:</p>
<blockquote>
<table>
<tr valign="top">
<td>
<p><strong>BOTFL</strong></p>
</td>
<td>
<p>returns the current bot-specific flags for the user
(bot-only)</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>BOTADDR</strong></p>
</td>
<td>
<p>returns a list containing the bot's address, telnet
port, and relay port (bot-only)</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>HOSTS</strong></p>
</td>
<td>
<p>returns a list of hosts for the user</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>LASTON</strong></p>
</td>
<td>
<p>returns a list containing the unixtime last seen and
the last seen place. LASTON #channel returns the time
last seen time for the channel or 0 if no info exists.</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>INFO</strong></p>
</td>
<td>
<p>returns the user's global info line</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>XTRA</strong></p>
</td>
<td>
<p>returns the user's XTRA info</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>COMMENT</strong></p>
</td>
<td>
<p>returns the master-visible only comment for the user</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>EMAIL</strong></p>
</td>
<td>
<p>returns the user's e-mail address</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>URL</strong></p>
</td>
<td>
<p>returns the user's url</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>HANDLE</strong></p>
</td>
<td>
<p>returns the user's handle as it is saved in the
userfile</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>PASS</strong></p>
</td>
<td>
<p>returns the user's encrypted password</p>
</td>
</tr>
</table>
</blockquote>
<p><strong>Returns:</strong> info specific to each entry-type</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_setuser"></a>setuser <handle> <entry-type>
[extra info]</strong></dt>
<dd>
<p><strong>Description:</strong> this is the counterpart of
getuser. It lets you set the various values. Other then the ones
listed below, the entry-types are the same as getuser's.</p>
<blockquote>
<table>
<tr valign="top">
<td>
<p><strong>HOSTS</strong></p>
</td>
<td>
<p>if used with no third arg, all hosts for the user will
be cleared. Otherwise, *1* hostmask is added :P</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>LASTON</strong></p>
</td>
<td>
<p>This setting has 3 forms. "setuser <handle>
LASTON <unixtime> <place>" sets global
LASTON time, "setuser <handle> LASTON
<unixtime>" sets global LASTON time (leaving the
place field empty), and "setuser <handle> LASTON
<unixtime> <channel>" sets a users LASTON
time for a channel (if it is a valid channel).</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>PASS</strong></p>
</td>
<td>
<p>sets a users password (no third arg will clear it)</p>
</td>
</tr>
</table>
</blockquote>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_chhandle"></a>chhandle <old-handle>
<new-handle></strong></dt>
<dd>
<p><strong>Description:</strong> changes a user's handle</p>
<p><strong>Returns:</strong> 1 on success; 0 if the new handle is
invalid or already used, or if the user can't be found</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_chattr"></a>chattr <handle> [changes [channel]]</strong></dt>
<dd>
<p><strong>Description:</strong> changes the attributes for a user
record, if you include any. Changes are of the form '+f',
'-o', '+dk', '-o+d', etc. If changes are
specified in the format of <changes> <channel>, the
channel-specific flags for that channel are altered. You can now
use the +o|-o #channel format here too.</p>
<p><strong>Returns:</strong> new flags for the user (if you made
no changes, the current flags are returned). If a channel was
specified, the global AND the channel-specific flags for that
channel are returned in the format of globalflags|channelflags.
"*" is returned if the specified user does not exist.</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_botattr"></a>botattr <handle> [changes [channel]]</strong></dt>
<dd>
<p><strong>Description:</strong> similar to chattr except this
modifies bot flags rather than normal user attributes.</p>
<p><strong>Returns:</strong> new flags for the bot (if you made
no changes, the current flags are returned). If a channel was
specified, the global AND the channel-specific flags for that
channel are returned in the format of globalflags|channelflags.
"*" is returned if the specified bot does not exist.</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_matchattr"></a>matchattr <handle> <flags>
[channel]</strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if the specified user has the
specified flags; 0 otherwise</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_adduser"></a>adduser <handle> [hostmask]</strong></dt>
<dd>
<p><strong>Description:</strong> creates a new user entry with the
handle and hostmask given (with no password and the default
flags)</p>
<p><strong>Returns:</strong> 1 if successful; 0 if the handle
already exists</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_addbot"></a>addbot <handle> <address></strong></dt>
<dd>
<p><strong>Description:</strong> adds a new bot to the userlist
with the handle and bot address given (with no password and no
flags)</p>
<p><strong>Returns:</strong> 1 if successful; 0 if the bot
already exists</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_deluser"></a>deluser <handle></strong></dt>
<dd>
<p><strong>Description:</strong> attempts to erase the user record
for a handle</p>
<p><strong>Returns:</strong> 1 if successful, 0 if no such user
exists</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_delhost"></a>delhost <handle> <hostmask></strong></dt>
<dd>
<p><strong>Description:</strong> deletes a hostmask from a
user's host list</p>
<p><strong>Returns:</strong> 1 on success; 0 if the hostmask (or
user) doesn't exist</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_addchanrec"></a>addchanrec <handle> <channel></strong></dt>
<dd>
<p><strong>Description:</strong> adds a channel record for a
user</p>
<p><strong>Returns:</strong> 1 on success; 0 if the user or channel
does not exist</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_delchanrec"></a>delchanrec <handle> <channel></strong></dt>
<dd>
<p><strong>Description:</strong> removes a channel record for a
user. This includes all associated channel flags.</p>
<p><strong>Returns:</strong> 1 on success; 0 if the user or channel
does not exist</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_haschanrec"></a>haschanrec <handle> <channel></strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if the given handle has a chanrec
for the specified channel; 0 otherwise</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_getchaninfo"></a>getchaninfo <handle> <channel></strong></dt>
<dd>
<p><strong>Returns:</strong> info line for a specific channel
(behaves just like 'getinfo')</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_setchaninfo"></a>setchaninfo <handle> <channel>
<info></strong></dt>
<dd>
<p><strong>Description:</strong> sets the info line on a specific
channel for a user. If info is "none", it will be
removed.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_newchanban"></a>newchanban <channel> <ban> <creator>
<comment> [lifetime] [options]</strong></dt>
<dd>
<p><strong>Description:</strong> adds a ban to the ban list of a
channel; creator is given credit for the ban in the ban list.
lifetime is specified in minutes. If lifetime is not specified,
ban-time (usually 60) is used. Setting the lifetime to 0 makes
it a permanent ban.</p>
<p><strong>Options:</strong></p>
<blockquote>
<p><strong>sticky</strong>: forces the ban to be always active
on a channel, even with dynamicbans on<br>
<strong>none</strong>: no effect</p>
</blockquote>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_newban"></a>newban <ban> <creator> <comment>
[lifetime] [options]</strong></dt>
<dd>
<p><strong>Description:</strong> adds a ban to the global ban list
(which takes effect on all channels); creator is given credit for
the ban in the ban list. lifetime is specified in minutes. If
lifetime is not specified, global-ban-time (usually 60) is used.
Setting the lifetime to 0 makes it a permanent ban.</p>
<p><strong>Options:</strong></p>
<blockquote>
<p><strong>sticky</strong>: forces the ban to be always active
on a channel, even with dynamicbans on<br>
<strong>none</strong>: no effect</p>
</blockquote>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_newchanexempt"></a>newchanexempt <channel> <exempt>
<creator> <comment> [lifetime] [options]</strong></dt>
<dd>
<p><strong>Description:</strong> adds a exempt to the exempt list
of a channel; creator is given credit for the exempt in the exempt
list. lifetime is specified in minutes. If lifetime is not
specified, exempt-time (usually 60) is used. Setting the lifetime
to 0 makes it a permanent exempt. The exempt will not be removed
until the corresponding ban has been removed. For timed bans,
once the time period has expired, the exempt will not be removed
until the corresponding ban has either expired or been removed.</p>
<p><strong>Options:</strong></p>
<blockquote>
<p><strong>sticky</strong>: forces the exempt to be always active
on a channel, even with dynamicexempts on<br>
<strong>none</strong>: no effect</p>
</blockquote>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_newexempt"></a>newexempt <exempt> <creator> <comment>
[lifetime] [options]</strong></dt>
<dd>
<p><strong>Description:</strong> adds a exempt to the global
exempt list (which takes effect on all channels); creator is
given credit for the exempt in the exempt list. lifetime is
specified in minutes. If lifetime is not specified, exempt-time
(usually 60) is used. Setting the lifetime to 0 makes it a
permanent exempt. The exempt will not be removed until the
corresponding ban has been removed.</p>
<p><strong>Options:</strong></p>
<blockquote>
<p><strong>sticky</strong>: forces the exempt to be always active
on a channel, even with dynamicexempts on<br>
<strong>none</strong>: no effect</p>
</blockquote>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_newchaninvite"></a>newchaninvite <channel> <invite>
<creator> <comment> [lifetime] [options]</strong></dt>
<dd>
<p><strong>Description:</strong> adds a invite to the invite list
of a channel; creator is given credit for the invite in the invite
list. lifetime is specified in minutes. If lifetime is not
specified, invite-time (usually 60) is used. Setting the lifetime
to 0 makes it a permanent invite. The invite will not be removed
until the channel has gone -i.</p>
<p><strong>Options:</strong></p>
<blockquote>
<p><strong>sticky</strong>: forces the invite to be always active
on a channel, even with dynamicinvites on<br>
<strong>none</strong>: no effect</p>
</blockquote>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_newinvite"></a>newinvite <invite> <creator> <comment>
[lifetime] [options]</strong></dt>
<dd>
<p><strong>Description:</strong> adds a invite to the global invite
list (which takes effect on all channels); creator is given credit
for the invite in the invite list. lifetime is specified in
minutes. If lifetime is not specified, invite-time (usually 60)
is used. Setting the lifetime to 0 makes it a permanent invite.
The invite will not be removed until the channel has gone -i.</p>
<p><strong>Options:</strong></p>
<blockquote>
<p><strong>sticky</strong>: forces the invite to be always active
on a channel, even with dynamicinvites on<br>
<strong>none</strong>: no effect</p>
</blockquote>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_stick"></a>stick <banmask> [channel]</strong></dt>
<dd>
<p><strong>Description:</strong> makes a ban sticky, or, if a
channel is specified, then it is set sticky on that channel
only.</p>
<p><strong>Returns:</strong> 1 on success; 0 otherwise</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_unstick"></a>unstick <banmask> [channel]</strong></dt>
<dd>
<p><strong>Description:</strong> makes a ban no longer sticky,
or, if a channel is specified, then it is unstuck on that channel
only.</p>
<p><strong>Returns:</strong> 1 on success; 0 otherwise</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_stickexempt"></a>stickexempt <exemptmask> [channel]</strong></dt>
<dd>
<p><strong>Description:</strong> makes an exempt sticky, or, if
a channel is specified, then it is set sticky on that channel
only.</p>
<p><strong>Returns:</strong> 1 on success; 0 otherwise</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_unstickexempt"></a>unstickexempt <exemptmask> [channel]</strong></dt>
<dd>
<p><strong>Description:</strong> makes an exempt no longer sticky,
or, if a channel is specified, then it is unstuck on that channel
only.</p>
<p><strong>Returns:</strong> 1 on success; 0 otherwise</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_stickinvite"></a>stickinvite <invitemask> [channel]</strong></dt>
<dd>
<p><strong>Description:</strong> makes an invite sticky, or, if
a channel is specified, then it is set sticky on that channel
only.</p>
<p><strong>Returns:</strong> 1 on success; 0 otherwise</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_unstickinvite"></a>unstickinvite <invitemask> [channel]</strong></dt>
<dd>
<p><strong>Description:</strong> makes an invite no longer sticky,
or, if a channel is specified, then it is unstuck on that channel
only.</p>
<p><strong>Returns:</strong> 1 on success; 0 otherwise</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_killchanban"></a>killchanban <channel> <ban></strong></dt>
<dd>
<p><strong>Description:</strong> removes a ban from the ban list
for a channel</p>
<p><strong>Returns:</strong> 1 on success; 0 otherwise</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_killban"></a>killban <ban></strong></dt>
<dd>
<p><strong>Description:</strong> removes a ban from the global
ban list</p>
<p><strong>Returns:</strong> 1 on success; 0 otherwise</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_killchanexempt"></a>killchanexempt <channel>
<exempt></strong></dt>
<dd>
<p><strong>Description:</strong> removes an exempt from the exempt
list for a channel</p>
<p><strong>Returns:</strong> 1 on success; 0 otherwise</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_killexempt"></a>killexempt <exempt></strong></dt>
<dd>
<p><strong>Description:</strong> removes an exempt from the global
exempt list</p>
<p><strong>Returns:</strong> 1 on success; 0 otherwise</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_killchaninvite"></a>killchaninvite <channel> <invite></strong></dt>
<dd>
<p><strong>Description:</strong> removes an invite from the invite
list for a channel</p>
<p><strong>Returns:</strong> 1 on success; 0 otherwise</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_killinvite"></a>killinvite <invite></strong></dt>
<dd>
<p><strong>Description:</strong> removes an invite from the global
invite list</p>
<p><strong>Returns:</strong> 1 on success; 0 otherwise</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_ischanjuped"></a>ischanjuped <channel></strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if the channel is juped, and the
bot is unable to join; 0 otherwise</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_isban"></a>isban <ban> [channel]</strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if the specified ban is in the
global ban list; 0 otherwise. If a channel is specified, that
channel's ban list is checked as well.</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_ispermban"></a>ispermban <ban> [channel]</strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if the specified ban is in the
global ban list AND is marked as permanent; 0 otherwise. If a
channel is specified, that channel's ban list is checked as
well.</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_isexempt"></a>isexempt <exempt> [channel]</strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if the specified exempt is in the
global exempt list; 0 otherwise. If a channel is specified, that
channel's exempt list is checked as well.</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_ispermexempt"></a>ispermexempt <exempt> [channel]</strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if the specified exempt is in the
global exempt list AND is marked as permanent; 0 otherwise. If a
channel is specified, that channel's exempt list is checked
as well.</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_isinvite"></a>isinvite <invite> [channel]</strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if the specified invite is in
the global invite list; 0 otherwise. If a channel is specified,
that channel's invite list is checked as well.</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_isperminvite"></a>isperminvite <invite> [channel]</strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if the specified invite is in
the global invite list AND is marked as permanent; 0 otherwise.
If a channel is specified, that channel's invite list is
checked as well.</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_isbansticky"></a>isbansticky <ban> [channel]</strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if the specified ban is marked as
sticky in the global ban list; 0 otherwise. If a channel is
specified, that channel's ban list is checked as well.</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_isexemptsticky"></a>isexemptsticky <exempt> [channel]</strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if the specified exempt is marked
as sticky in the global exempt list; 0 otherwise. If a channel is
specified, that channel's exempt list is checked as well.</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_isinvitesticky"></a>isinvitesticky <invite> [channel]</strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if the specified invite is marked
as sticky in the global invite list; 0 otherwise. If a channel
is specified, that channel's invite list is checked as well.</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_matchban"></a>matchban <nick!user@host> [channel]</strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if the specified nick!user@host
matches a ban in the global ban list; 0 otherwise. If a channel
is specified, that channel's ban list is checked as well.</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_matchexempt"></a>matchexempt <nick!user@host>
[channel]</strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if the specified nick!user@host
matches an exempt in the global exempt list; 0 otherwise. If a
channel is specified, that channel's exempt list is checked
as well.</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_matchinvite"></a>matchinvite <nick!user@host> [channel]</strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if the specified nick!user@host
matches an invite in the global invite list; 0 otherwise. If a
channel is specified, that channel's invite list is checked
as well.</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_banlist"></a>banlist [channel]</strong></dt>
<dd>
<p><strong>Returns:</strong> a list of global bans, or, if a
channel is specified, a list of channel-specific bans. Each entry
is a sublist containing: hostmask, comment, expiration timestamp,
time added, last time active, and creator. The three timestamps
are in unixtime format.</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_exemptlist"></a>exemptlist [channel]</strong></dt>
<dd>
<p><strong>Returns:</strong> a list of global exempts, or, if a
channel is specified, a list of channel-specific exempts. Each
entry is a sublist containing: hostmask, comment, expiration
timestamp, time added, last time active, and creator. The three
timestamps are in unixtime format.</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_invitelist"></a>invitelist [channel]</strong></dt>
<dd>
<p><strong>Returns:</strong> a list of global invites, or, if a
channel is specified, a list of channel-specific invites. Each
entry is a sublist containing: hostmask, comment, expiration
timestamp, time added, last time active, and creator. The three
timestamps are in unixtime format.</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_newignore"></a>newignore <hostmask> <creator>
<comment> [lifetime]</strong></dt>
<dd>
<p><strong>Description:</strong> adds an entry to the ignore list;
creator is given credit for the ignore. lifetime is how many
minutes until the ignore expires and is removed. If lifetime is
not specified, ignore-time (usually 60) is used. Setting the
lifetime to 0 makes it a permanent ignore.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_killignore"></a>killignore <hostmask></strong></dt>
<dd>
<p><strong>Description:</strong> removes an entry from the ignore
list</p>
<p><strong>Returns:</strong> 1 if successful; 0 otherwise</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_ignorelist"></a>ignorelist</strong></dt>
<dd>
<p><strong>Returns:</strong> a list of ignores. Each entry is a
sublist containing: hostmask, comment, expiration timestamp, time
added, and creator. The timestamps are in unixtime format.</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_isignore"></a>isignore <hostmask></strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if the ignore is in the list;
0 otherwise</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_save"></a>save</strong></dt>
<dd>
<p><strong>Description:</strong> writes the user and channel files
to disk</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_reload"></a>reload</strong></dt>
<dd>
<p><strong>Description:</strong> loads the userfile from disk,
replacing whatever is in memory</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_backup"></a>backup</strong></dt>
<dd>
<p><strong>Description:</strong> makes a simple backup of the
userfile that's on disk. If the channels module is loaded,
this also makes a simple backup of the channel file.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_getting-users"></a>getting-users</strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if the bot is currently downloading
a userfile from a sharebot (and hence, user records are about to
drastically change); 0 if not</p>
<p><strong>Module:</strong> core</p>
</dd>
</dl>
</blockquote>
<p><a name="chancmds"></a><a name="cmd_channel"></a>3. <strong>Channel commands</strong></p>
<blockquote>
<dl>
<dt><strong><a name="cmd_channel_add"></a>channel add <name> [option-list]</strong></dt>
<dd>
<p><strong>Description:</strong> adds a channel record for the
bot to monitor. The full list of possible options are given in
doc/settings/mod.channels. Note that the channel options must be
in a list (enclosed in {}).</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_channel_set"></a>channel set <name> <options...></strong></dt>
<dd>
<p><strong>Description:</strong> sets options for the channel
specified. The full list of possible options are given in
doc/settings/mod.channels.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_channel_info"></a>channel info <name></strong></dt>
<dd>
<p><strong>Returns:</strong> a list of info about the specified
channel's settings.</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_channel_get"></a>channel get <name> <setting></strong></dt>
<dd>
<p><strong>Returns:</strong> The value of the setting you specify.
For flags, a value of 0 means it is disabled (-), and non-zero means
enabled (+).</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_channel_remove"></a>channel remove <name></strong></dt>
<dd>
<p><strong>Description:</strong> removes a channel record from
the bot and makes the bot no longer monitor the channel</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_savechannels"></a>savechannels</strong></dt>
<dd>
<p><strong>Description:</strong> saves the channel settings to
the channel-file if one is defined.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_loadchannels"></a>loadchannels</strong></dt>
<dd>
<p><strong>Description:</strong> reloads the channel settings from
the channel-file if one is defined.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_channels"></a>channels</strong></dt>
<dd>
<p><strong>Returns:</strong> a list of the channels the bot has
a channel record for</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_channame2dname"></a>channame2dname <channel-name></strong></dt>
<dt><strong><a name="cmd_chandname2name"></a>chandname2name <channel-dname></strong></dt>
<dd>
<p><strong>Description:</strong> these two functions are important
to correctly support !channels. The bot differentiates between
channel description names (chan dnames) and real channel names
(chan names). The chan dnames are what you would normally call
the channel, such as "!channel". The chan names are
what the IRC server uses to identify the channel. They consist
of the chan dname prefixed with an ID; such as
"!ABCDEchannel".</p>
<p>For bot functions like isop, isvoice, etc. you need to know
the chan dnames. If you communicate with the server, you usually
get the chan name, though. That's what you need the
channame2dname function for.</p>
<p>If you only have the chan dname and want to directly send raw
server commands, use the chandname2name command.</p>
<p>For non-!channels, chan dname and chan name are the same.</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_isbotnick"></a>isbotnick <nick></strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if the nick matches the botnick;
0 otherwise</p>
<p><strong>Module:</strong> server</p>
</dd>
<dt><strong><a name="cmd_botisop"></a>botisop [channel]</strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if the bot has ops on the specified
channel (or any channel if no channel is specified); 0
otherwise</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_botishalfop"></a>botishalfop [channel]</strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if the bot has halfops on the
specified channel (or any channel if no channel is specified); 0
otherwise</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_botisvoice"></a>botisvoice [channel]</strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if the bot has a voice on the
specified channel (or any channel if no channel is specified); 0
otherwise</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_botonchan"></a>botonchan [channel]</strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if the bot is on the specified
channel (or any channel if no channel is specified); 0
otherwise</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_isop"></a>isop <nickname> [channel]</strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if someone by the specified
nickname is on the channel (or any channel if no channel name is
specified) and has ops; 0 otherwise</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_ishalfop"></a>ishalfop <nickname> [channel]</strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if someone by the specified
nickname is on the channel (or any channel if no channel name is
specified) and has halfops; 0 otherwise</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_wasop"></a>wasop <nickname> <channel></strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if someone that just got
opped/deopped in the chan had op before the modechange; 0
otherwise</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_washalfop"></a>washalfop <nickname> <channel></strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if someone that just got
halfopped/dehalopped in the chan had halfop before the modechange; 0
otherwise</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_isvoice"></a>isvoice <nickname> [channel]</strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if someone by that nickname is on
the channel (or any channel if no channel is specified) and has
voice (+v); 0 otherwise</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_onchan"></a>onchan <nickname> [channel]</strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if someone by that nickname is on
the specified channel (or any channel if none is specified); 0
otherwise</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_nick2hand"></a>nick2hand <nickname> [channel]</strong></dt>
<dd>
<p><strong>Returns:</strong> the handle of a nickname on a channel.
If a channel is not specified, the bot will check all of its
channels. If the nick is not found, "" is returned. If
the nick is found but does not have a handle, "*" is
returned.</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_hand2nick"></a>hand2nick <handle> [channel]</strong></dt>
<dd>
<p><strong>Returns:</strong> nickname of the first person on the
specified channel (if one is specified) whose nick!user@host
matches the given handle; "" is returned if no match
is found. If no channel is specified, all channels are checked.</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_handonchan"></a>handonchan <handle> [channel]</strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if the the nick!user@host for
someone on the channel (or any channel if no channel name is
specified) matches for the handle given; 0 otherwise</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_ischanban"></a>ischanban <ban> <channel></strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if the specified ban is on the
given channel's ban list (not the bot's banlist for the
channel)</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_ischanexempt"></a>ischanexempt <exempt> <channel></strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if the specified exempt is on the
given channel's exempt list (not the bot's exemptlist for
the channel)</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_ischaninvite"></a>ischaninvite <invite> <channel></strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if the specified invite is on the
given channel's invite list (not the bot's invitelist for
the channel)</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_chanbans"></a>chanbans <channel></strong></dt>
<dd>
<p><strong>Returns:</strong> a list of the current bans on the
channel. Each element is a sublist of the form {<ban>
<bywho> <age>}. age is seconds from the bot's
point of view</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_chanexempts"></a>chanexempts <channel></strong></dt>
<dd>
<p><strong>Returns:</strong> a list of the current exempts on the
channel. Each element is a sublist of the form {<exempts>
<bywho> <age>}. age is seconds from the bot's
point of view</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_chaninvites"></a>chaninvites <channel></strong></dt>
<dd>
<p><strong>Returns:</strong> a list of the current invites on the
channel. Each element is a sublist of the form {<invites>
<bywho> <age>}. age is seconds from the bot's
point of view</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_resetbans"></a>resetbans <channel></strong></dt>
<dd>
<p><strong>Description:</strong> removes all bans on the channel
that aren't in the bot's ban list and refreshes any bans
that should be on the channel but aren't</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_resetexempts"></a>resetexempts [channel]</strong></dt>
<dd>
<p><strong>Description:</strong> removes all exempt on the channel
that aren't in the bot's exempt list and refreshes any
exempts that should be on the channel but aren't</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_resetinvites"></a>resetinvites [channel]</strong></dt>
<dd>
<p><strong>Description:</strong> removes all invites on the channel
that aren't in the bot's invite list and refreshes any
invites that should be on the channel but aren't</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_resetchanidle"></a>resetchanidle [nick]
<channel></strong></dt>
<dd>
<p><strong>Description:</strong> resets the channel idle time for
the given nick or for all nicks on the channel if no nick is
specified.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_resetchanjoin"></a>resetchanjoin [nick]
<channel></strong></dt>
<dd>
<p><strong>Description:</strong> resets the channel join time for
the given nick or for all nicks on the channel if no nick is
specified.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_resetchan"></a>resetchan <channel>
[flags]</strong></dt>
<dd>
<p><strong>Description:</strong> rereads in the channel info from
the server. If flags are specified, only the required information
will be reset, according to the given flags. Available flags are:</p>
<blockquote>
<table>
<tr valign="top">
<td>
<p><strong>b</strong></p>
</td>
<td>
<p>reset channel bans</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>e</strong></p>
</td>
<td>
<p>reset channel exempts</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>I</strong></p>
</td>
<td>
<p>reset channel invites</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>m</strong></p>
</td>
<td>
<p>reset channel modes</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>t</strong></p>
</td>
<td>
<p>refresh channel topic</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>w</strong></p>
</td>
<td>
<p>refresh memberlist</p>
</td>
</tr>
</table>
</blockquote>
<p><strong>Returns:</strong> nothing </p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_getchanhost"></a>getchanhost <nickname> [channel]</strong></dt>
<dd>
<p><strong>Returns:</strong> user@host of the specified nickname
(the nickname is not included in the returned host). If a channel
is not specified, bot will check all of its channels. If the
nickname is not on the channel(s), "" is returned.</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_getchanjoin"></a>getchanjoin <nickname> <channel></strong></dt>
<dd>
<p><strong>Returns:</strong> timestamp (unixtime format) of when
the specified nickname joined the channel if available, 0
otherwise. Note that after a channel reset this information will be
lost, even if previously available.</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_onchansplit"></a>onchansplit <nick> [channel]</strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if that nick is split from the
channel (or any channel if no channel is specified); 0
otherwise</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_chanlist"></a>chanlist <channel>
[flags[&chanflags]]</strong></dt>
<dd>
<p><strong>Description:</strong> flags are any global flags; the
'&' denotes to look for channel specific flags.
Examples:</p>
<blockquote>
<table>
<tr valign="top">
<td>
<p><strong>n</strong></p>
</td>
<td>
<p>Global Owner</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>&n</strong></p>
</td>
<td>
<p>Channel Owner</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>o&m</strong></p>
</td>
<td>
<p>Global Op, Channel Master</p>
</td>
</tr>
</table>
</blockquote>
<p><strong>Returns:</strong> list of nicknames currently on the
bot's channel that have all of the flags specified;. If no
flags are given, all of the nicknames are returned. Please note
that if you're executing chanlist after a part or sign bind,
the gone user will still be listed, so you can check for wasop,
isop, etc.</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_getchanidle"></a>getchanidle <nickname> <channel></strong></dt>
<dd>
<p><strong>Returns:</strong> number of minutes that person has
been idle; 0 if the specified user isn't on the channel</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_getchanmode"></a>getchanmode <channel></strong></dt>
<dd>
<p><strong>Returns:</strong> string of the type "+ntik
key" for the channel specified</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_jump"></a>jump [server [port [password]]]</strong></dt>
<dd>
<p><strong>Description:</strong> jumps to the server specified,
or (if none is specified) the next server in the bot's
serverlist</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> server</p>
</dd>
<dt><strong><a name="cmd_pushmode"></a>pushmode <channel> <mode> [arg]</strong></dt>
<dd>
<p><strong>Description:</strong> sends out a channel mode change
(ex: pushmode #lame +o goober) through the bot's queuing
system. All the mode changes will be sent out at once (combined
into one line as much as possible) after the script finishes, or
when 'flushmode' is called.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_flushmode"></a>flushmode <channel></strong></dt>
<dd>
<p><strong>Description:</strong> forces all previously pushed
channel mode changes to be sent to the server, instead of when
the script is finished (just for the channel specified)</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_topic"></a>topic <channel></strong></dt>
<dd>
<p><strong>Returns:</strong> string containing the current topic
of the specified channel</p>
<p><strong>Module:</strong> irc</p>
</dd>
<dt><strong><a name="cmd_validchan"></a>validchan <channel></strong></dt>
<dd>
<p><strong>Description:</strong> checks if the bot has a channel
record for the specified channel. Note that this does not
necessarily mean that the bot is ON the channel.</p>
<p><strong>Returns:</strong> 1 if the channel exists, 0 if not</p>
<p><strong>Module:</strong> nothing</p>
</dd>
<dt><strong><a name="cmd_isdynamic"></a>isdynamic <channel></strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if the channel is a dynamic
channel; 0 otherwise</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_setudef"></a>setudef <flag/int/str> <name></strong></dt>
<dd>
<p><strong>Description:</strong> initializes a user defined channel
flag, string, or integer setting. You can use it like any other
flag/setting. IMPORTANT: Don't forget to reinitialize your
flags/settings after a restart, or it'll be lost.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_renudef"></a>renudef <flag/int/str> <oldname>
<newname></strong></dt>
<dd>
<p><strong>Description:</strong> renames a user defined channel
flag, string, or integer setting.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> channels</p>
</dd>
<dt><strong><a name="cmd_deludef"></a>deludef <flag/int/str> <name></strong></dt>
<dd>
<p><strong>Description:</strong> deletes a user defined channel
flag, string, or integer setting.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> channels</p>
</dd>
</dl>
</blockquote>
<p><a name="dcccmds"></a>4. <strong>Dcc commands</strong></p>
<blockquote>
<dl>
<dt><strong><a name="cmd_putdcc"></a>putdcc <idx> <text> [-raw]</strong></dt>
<dd>
<p><strong>Description:</strong> sends text to the idx specified.
If -raw is specified, the text will be sent as is, without forced
new lines or limits to line length.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_dccbroadcast"></a>dccbroadcast <message></strong></dt>
<dd>
<p><strong>Description:</strong> sends a message to everyone on
the party line across the botnet, in the form of "***
<message>" for local users and "*** (Bot)
<message>" for users on other bots</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_dccputchan"></a>dccputchan <channel> <message></strong></dt>
<dd>
<p><strong>Description:</strong> sends your message to everyone
on a certain channel on the botnet, in a form exactly like
dccbroadcast does. Valid channels are 0 through 99999.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_boot"></a>boot <user@bot> [reason]</strong></dt>
<dd>
<p><strong>Description:</strong> boots a user from the partyline</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_dccsimul"></a>dccsimul <idx> <text></strong></dt>
<dd>
<p><strong>Description:</strong> simulates text typed in by the
dcc user specified. Note that in v0.9, this only simulated
commands; now a command must be preceded by a '.' to be
simulated.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_hand2idx"></a>hand2idx <handle></strong></dt>
<dd>
<p><strong>Returns:</strong> the idx (a number greater than or
equal to zero) for the user given if the user is on the party
line in chat mode (even if she is currently on a channel or in
chat off), the file area, or in the control of a script. -1 is
returned if no idx is found. If the user is on multiple times,
the oldest idx is returned.</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_idx2hand"></a>idx2hand <idx></strong></dt>
<dd>
<p><strong>Returns:</strong> handle of the user with the given
idx</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_valididx"></a>valididx <idx></strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if the idx currently exists; 0
otherwise</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_getchan"></a>getchan <idx></strong></dt>
<dd>
<p><strong>Returns:</strong> the current party line channel
for a user on the party line; "0" indicates he's
on the group party line, "-1" means he has chat off,
and a value from 1 to 99999 is a private channel</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_setchan"></a>setchan <idx> <channel></strong></dt>
<dd>
<p><strong>Description:</strong> sets a party line user's
channel. The party line user is not notified that she is now on
a new channel. A channel name can be used (provided it exists).</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_console"></a>console <idx> [channel]
[console-modes]</strong></dt>
<dd>
<p><strong>Description:</strong> changes a dcc user's console
mode, either to an absolute mode (like "mpj") or just
adding/removing flags (like "+pj" or "-moc"
or "+mp-c"). The user's console channel view can be
changed also (as long as the new channel is a valid channel).</p>
<p><strong>Returns:</strong> a list containing the user's (new)
channel view and (new) console modes, or nothing if that user
isn't currently on the partyline</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_echo"></a>echo <idx> [status]</strong></dt>
<dd>
<p><strong>Description:</strong> turns a user's echo on or
off; the status has to be a 1 or 0</p>
<p><strong>Returns:</strong> new value of echo for that user (or
the current value, if status was omitted)</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_strip"></a>strip <idx> [+/-strip-flags]</strong></dt>
<dd>
<p><strong>Description:</strong> modifies the strip-flags for a
user. The supported strip-flags are:</p>
<blockquote>
<table>
<tr valign="top">
<td>
<p><strong>b</strong></p>
</td>
<td>
<p>remove all boldface codes</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>c</strong></p>
</td>
<td>
<p>remove all color codes</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>r</strong></p>
</td>
<td>
<p>remove all reverse video codes</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>u</strong></p>
</td>
<td>
<p>remove all underline codes</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>a</strong></p>
</td>
<td>
<p>remove all ANSI codes</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>g</strong></p>
</td>
<td>
<p>remove all ctrl-g (bell) codes</p>
</td>
</tr>
</table>
</blockquote>
<p><strong>Returns:</strong> new strip-flags for the specified user
(or the current flags, if strip-flags was omitted)</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_putbot"></a>putbot <bot-nick> <message></strong></dt>
<dd>
<p><strong>Description:</strong> sends a message across the
botnet to another bot. If no script intercepts the message on
the other end, the message is ignored.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_putallbots"></a>putallbots <message></strong></dt>
<dd>
<p><strong>Description:</strong> sends a message across the botnet
to all bots. If no script intercepts the message on the other end,
the message is ignored.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_killdcc"></a>killdcc <idx></strong></dt>
<dd>
<p><strong>Description:</strong> kills a partyline or file area
connection</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_bots"></a>bots</strong></dt>
<dd>
<p><strong>Returns:</strong> list of the bots currently connected
to the botnet</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_botlist"></a>botlist</strong></dt>
<dd>
<p><strong>Returns:</strong> a list of bots currently on the
botnet. Each item in the list is a sublist with four elements:
bot, uplink, version, sharing status:</p>
<blockquote>
<table>
<tr valign="top">
<td>
<p><strong>bot</strong></p>
</td>
<td>
<p>the bot's botnetnick</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>uplink</strong></p>
</td>
<td>
<p>the bot the bot is connected to</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>version</strong></p>
</td>
<td>
<p>its current numeric version</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>sharing</strong></p>
</td>
<td>
<p>a "+" if the bot is a sharebot; "-"
otherwise</p>
</td>
</tr>
</table>
</blockquote>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_islinked"></a>islinked <bot></strong></dt>
<dd>
<p><strong>Returns:</strong> 1 if the bot is currently linked; 0
otherwise</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_dccused"></a>dccused</strong></dt>
<dd>
<p><strong>Returns:</strong> number of dcc connections currently
in use</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_dcclist"></a>dcclist [type]</strong></dt>
<dd>
<p><strong>Returns:</strong> a list of active connections, each
item in the list is a sublist containing six elements: {<idx>
<handle> <hostname> <type> {<other>}
<timestamp>}</p>
<p>The types are: chat, bot, files, file_receiving, file_sending,
file_send_pending, script, socket (these are connections that
have not yet been put under 'control'), telnet, and server.
The timestamp is in unixtime format.</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_whom"></a>whom <chan></strong></dt>
<dd>
<p><strong>Returns:</strong> list of people on the botnet who are
on that channel. 0 is the default party line. Each item in the
list is a sublist with six elements: nickname, bot, hostname,
access flag ('-', '@', '+', or
'*'), minutes idle, and away message (blank if the user
is not away). If you specify * for channel, every user on the
botnet is returned with an extra argument indicating the channel
the user is on.</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_getdccidle"></a>getdccidle <idx></strong></dt>
<dd>
<p><strong>Returns:</strong> number of seconds the dcc chat/file
system/script user has been idle</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_getdccaway"></a>getdccaway <idx></strong></dt>
<dd>
<p><strong>Returns:</strong> away message for a dcc chat user
(or "" if the user is not set away)</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_setdccaway"></a>setdccaway <idx> <message></strong></dt>
<dd>
<p><strong>Description:</strong> sets a party line user's away
message and marks them away. If set to "", the user is
marked as no longer away.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_connect"></a>connect <host> <port></strong></dt>
<dd>
<p><strong>Description:</strong> makes an outgoing connection
attempt and creates a dcc entry for it. A 'control'
command should be used immediately after a successful
'connect' so no input is lost.</p>
<p><strong>Returns:</strong> idx of the new connection</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_listen"></a>listen <port> <type> [options]
[flag]</strong></dt>
<dd>
<p><strong>Description:</strong> opens a listening port to accept
incoming telnets; type must be one of "bots",
"all", "users", "script", or
"off":</p>
<blockquote>
<dl>
<dt><strong>listen <port> bots [mask]</strong></dt>
<dd>
<p><strong>Description:</strong> accepts connections from
bots only; the optional mask is used to identify permitted
bot names. If the mask begins with '@', it is
interpreted to be a mask of permitted hosts to accept
connections from.</p>
<p><strong>Returns:</strong> port number</p>
</dd>
<dt><strong>listen <port> users [mask]</strong></dt>
<dd>
<p><strong>Description:</strong> accepts connections from
users only (no bots); the optional mask is used to identify
permitted nicknames. If the mask begins with '@', it
is interpreted to be a mask of permitted hosts to accept
connections from.</p>
<p><strong>Returns:</strong> port number</p>
</dd>
<dt><strong>listen <port> all [mask]</strong></dt>
<dd>
<p><strong>Description:</strong> accepts connections from
anyone; the optional mask is used to identify permitted
nicknames/botnames. If the mask begins with '@',
it is interpreted to be a mask of permitted hosts to accept
connections from.</p>
<p><strong>Returns:</strong> port number</p>
</dd>
<dt><strong>listen <port> script <proc>
[flag]</strong></dt>
<dd>
<p><strong>Description:</strong> accepts connections which
are immediately routed to a proc. The proc is called with
one parameter: the idx of the new connection. Flag may
currently only be 'pub', which makes the bot allow
anyone to connect.</p>
<p><strong>Returns:</strong> port number</p>
</dd>
<dt><strong>listen <port> off</strong></dt>
<dd>
<p><strong>Description:</strong> stop listening on a port</p>
<p><strong>Returns:</strong> nothing</p>
</dd>
</dl>
</blockquote>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_dccdumpfile"></a>dccdumpfile <idx> <filename></strong></dt>
<dd>
<p><strong>Description:</strong> dumps out a file from the text
directory to a dcc chat user. The flag matching that's used
everywhere else works here, too.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
</dl>
</blockquote>
<p><a name="notes"></a>5. <strong>Notes module</strong></p>
<blockquote>
<dl>
<dt><strong><a name="cmd_notes"></a>notes <user> [numberlist]</strong></dt>
<dd>
<p><strong>Returns:</strong> -1 if no such user, -2 if notefile
failure. If a numberlist is not specified, the number of notes
stored for the user is returned. Otherwise, a list of sublists
containing information about notes stored for the user is
returned. Each sublist is in the format of: {<from>
<timestamp> <note text>}.</p>
<p><strong>Module:</strong> notes</p>
</dd>
<dt><strong><a name="cmd_erasenotes"></a>erasenotes <user> <numberlist></strong></dt>
<dd>
<p><strong>Description:</strong> erases some or all stored notes
for a user. Use '-' to erase all notes.</p>
<p><strong>Returns:</strong> -1 if no such user, -2 if notefile
failure, 0 if no such note, or number of erased notes.</p>
<p><strong>Module:</strong> notes</p>
</dd>
<dt><strong><a name="cmd_listnotes"></a>listnotes <user> <numberlist></strong></dt>
<dd>
<p><strong>Description:</strong> lists existing notes according
to the numberlist (ex: "2-4;8;16-")</p>
<p><strong>Returns:</strong> -1 if no such user, -2 if notefile
failure, 0 if no such note, list of existing notes.</p>
<p><strong>Module:</strong> notes</p>
</dd>
<dt><strong><a name="cmd_storenote"></a>storenote <from> <to> <msg>
<idx></strong></dt>
<dd>
<p><strong>Description:</strong> stores a note for later reading,
notifies idx of any results (use idx -1 for no notify).</p>
<p><strong>Returns:</strong> 0 on success; non-0 on failure</p>
<p><strong>Module:</strong> notes</p>
</dd>
</dl>
</blockquote>
<p><a name="assoc"></a>6. <strong>Assoc module</strong></p>
<blockquote>
<dl>
<dt><strong><a name="cmd_assoc"></a>assoc <chan> [name]</strong></dt>
<dd>
<p><strong>Description:</strong> sets the name associated with a
botnet channel, if you specify one</p>
<p><strong>Returns:</strong> current name for that channel, if
any</p>
<p><strong>Module:</strong> assoc</p>
</dd>
<dt><strong><a name="cmd_killassoc"></a>killassoc <chan></strong></dt>
<dd>
<p><strong>Description:</strong> removes the name associated
with a botnet channel, if any exists. Use 'killassoc &'
to kill all assocs.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> assoc</p>
</dd>
</dl>
</blockquote>
<p><a name="compress"></a>7. <strong>Compress module</strong></p>
<blockquote>
<dl>
<dt><strong><a name="cmd_compressfile"></a>compressfile [-level <level>] <src-file>
[target-file]<br>
<a name="cmd_uncompressfile"></a>uncompressfile <src-file> [target-file]</strong></dt>
<dd>
<p><strong>Description:</strong> compresses or un-compresses
files. The level option specifies the compression mode to use
when compressing. Available modes are from 0 (minimum CPU usage,
minimum compression) all the way up to 9 (maximum CPU usage,
maximum compression). If you don't specify the target-file,
the src-file will be overwritten.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> compress</p>
</dd>
<dt><strong><a name="cmd_iscompressed"></a>iscompressed <filename></strong></dt>
<dd>
<p><strong>Description:</strong> determines whether
<filename> is gzip compressed. Returns 1 if it is, 0 if it
isn't, and 2 if some kind of error prevented the checks from
succeeding.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> compress</p>
</dd>
</dl>
</blockquote>
<p><a name="filesys"></a>8. <strong>Filesys module</strong></p>
<blockquote>
<dl>
<dt><strong><a name="cmd_setpwd"></a>setpwd <idx> <dir></strong></dt>
<dd>
<p><strong>Description:</strong> changes the directory of a file
system user, in exactly the same way as a 'cd' command
would. The directory can be specified relative or absolute.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> filesys</p>
</dd>
<dt><strong><a name="cmd_getpwd"></a>getpwd <idx></strong></dt>
<dd>
<p><strong>Returns:</strong> the current directory of a file
system user</p>
<p><strong>Module:</strong> filesys</p>
</dd>
<dt><strong><a name="cmd_getfiles"></a>getfiles <dir></strong></dt>
<dd>
<p><strong>Returns:</strong> a list of files in the directory
given; the directory is relative to dcc-path</p>
<p><strong>Module:</strong> filesys</p>
</dd>
<dt><strong><a name="cmd_getdirs"></a>getdirs <dir></strong></dt>
<dd>
<p><strong>Returns:</strong> a list of subdirectories in the
directory given; the directory is relative to dcc-path</p>
<p><strong>Module:</strong> filesys</p>
</dd>
<dt><strong><a name="cmd_dccsend"></a>dccsend <filename> <ircnick></strong></dt>
<dd>
<p><strong>Description:</strong> attempts to start a dcc file
transfer to the given nick; the filename must be specified either
by full pathname or in relation to the bot's startup
directory</p>
<p><strong>Returns:</strong></p>
<blockquote>
<table>
<tr valign="top">
<td>
<p><strong>0</strong></p>
</td>
<td>
<p>success</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>1</strong></p>
</td>
<td>
<p>the dcc table is full (too many connections)</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>2</strong></p>
</td>
<td>
<p>can't open a socket for the transfer</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>3</strong></p>
</td>
<td>
<p>the file doesn't exist</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>4</strong></p>
</td>
<td>
<p>the file was queued for later transfer, which means that
person has too many file transfers going right now</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>5</strong></p>
</td>
<td>
<p>copy-to-tmp is enabled and the file already exists in the
temp directory</p>
</td>
</tr>
</table>
</blockquote>
<p><strong>Module:</strong> transfer</p>
</dd>
<dt><strong><a name="cmd_filesend"></a>filesend <idx> <filename>
[ircnick]</strong></dt>
<dd>
<p><strong>Description:</strong> like dccsend, except it operates
for a current filesystem user, and the filename is assumed to be
a relative path from that user's current directory</p>
<p><strong>Returns:</strong> 0 on failure; 1 on success (either an
immediate send or a queued send)</p>
<p><strong>Module:</strong> filesys</p>
</dd>
<dt><strong><a name="cmd_fileresend"></a>fileresend <idx> <filename>
[ircnick]</strong></dt>
<dd>
<p><strong>Description:</strong> functions like filesend, only that
it sends a DCC RESEND instead of a DCC SEND, which allows people
to resume aborted file transfers if their client supports that
protocol. ircII/BitchX/etc. support it; mIRC does not.</p>
<p><strong>Returns:</strong> 0 on failure; 1 on success (either
an immediate send or a queued send)</p>
<p><strong>Module:</strong> filesys</p>
</dd>
<dt><strong><a name="cmd_setdesc"></a>setdesc <dir> <file> <desc></strong></dt>
<dd>
<p><strong>Description:</strong> sets the description for a file
in a file system directory; the directory is relative to
dcc-path</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> filesys</p>
</dd>
<dt><strong><a name="cmd_getdesc"></a>getdesc <dir> <file></strong></dt>
<dd>
<p><strong>Returns:</strong> the description for a file in the
file system, if one exists</p>
<p><strong>Module:</strong> filesys</p>
</dd>
<dt><strong><a name="cmd_setowner"></a>setowner <dir> <file>
<handle></strong></dt>
<dd>
<p><strong>Description:</strong> changes the owner for a file in
the file system; the directory is relative to dcc-path</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> filesys</p>
</dd>
<dt><strong><a name="cmd_getowner"></a>getowner <dir> <file></strong></dt>
<dd>
<p><strong>Returns:</strong> the owner of a file in the file
system</p>
<p><strong>Module:</strong> filesys</p>
</dd>
<dt><strong><a name="cmd_setlink"></a>setlink <dir> <file> <link></strong></dt>
<dd>
<p><strong>Description:</strong> creates or changes a linked file
(a file that actually exists on another bot); the directory is
relative to dcc-path</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> filesys</p>
</dd>
<dt><strong><a name="cmd_getlink"></a>getlink <dir> <file></strong></dt>
<dd>
<p><strong>Returns:</strong> the link for a linked file, if it
exists</p>
<p><strong>Module:</strong> filesys</p>
</dd>
<dt><strong><a name="cmd_getfileq"></a>getfileq <handle></strong></dt>
<dd>
<p><strong>Returns:</strong> list of files queued by someone;
each item in the list will be a sublist with two elements: nickname
the file is being sent to and the filename</p>
<p><strong>Module:</strong> transfer</p>
</dd>
<dt><strong><a name="cmd_getfilesendtime"></a>getfilesendtime <idx></strong></dt>
<dd>
<p><strong>Returns:</strong> the unixtime value for when a file
transfer started, or a negative number:</p>
<blockquote>
<table>
<tr valign="top">
<td>
<p><strong>-1</strong></p>
</td>
<td>
<p>no matching transfer with the specified idx was found</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>-2</strong></p>
</td>
<td>
<p>the idx matches an entry which is not a file transfer</p>
</td>
</tr>
</table>
</blockquote>
<p><strong>Module:</strong> transfer</p>
</dd>
<dt><strong><a name="cmd_mkdir"></a>mkdir <directory> [<required-flags>
[channel]]</strong></dt>
<dd>
<p><strong>Description:</strong> creates a directory in the file
system. Only users with the required flags may access it.</p>
<p><strong>Returns:</strong></p>
<blockquote>
<table>
<tr valign="top">
<td>
<p><strong>0</strong></p>
</td>
<td>
<p>success</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>1</strong></p>
</td>
<td>
<p>can't create directory</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>2</strong></p>
</td>
<td>
<p>directory exists but is not a directory</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>-3</strong></p>
</td>
<td>
<p>could not open filedb</p>
</td>
</tr>
</table>
</blockquote>
<p><strong>Module:</strong> filesys</p>
</dd>
<dt><strong><a name="cmd_rmdir"></a>rmdir <directory></strong></dt>
<dd>
<p><strong>Description:</strong> removes a directory from the
file system.</p>
<p><strong>Returns:</strong> 0 on success; 1 on failure</p>
<p><strong>Module:</strong> filesys</p>
</dd>
<dt><strong><a name="cmd_mv"></a>mv <file> <destination></strong></dt>
<dd>
<p><strong>Description:</strong> moves a file from its source to
the given destination. The file can also be a mask, such as
/incoming/*, provided the destination is a directory.</p>
<p><strong>Returns:</strong> If the command was successful, the
number of files moved will be returned. Otherwise, a negative
number will be returned:</p>
<blockquote>
<table>
<tr valign="top">
<td>
<p><strong>-1</strong></p>
</td>
<td>
<p>invalid source file</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>-2</strong></p>
</td>
<td>
<p>invalid destination</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>-3</strong></p>
</td>
<td>
<p>destination file exists</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>-4</strong></p>
</td>
<td>
<p>no matches found</p>
</td>
</tr>
</table>
</blockquote>
<p><strong>Module:</strong> filesys</p>
</dd>
<dt><strong><a name="cmd_cp"></a>cp <file> <destination></strong></dt>
<dd>
<p><strong>Description:</strong> copies a file from its source
to the given destination. The file can also be a mask, such as
/incoming/*, provided the destination is a directory.</p>
<p><strong>Returns:</strong> If the command was successful, the
number of files copied will be returned. Otherwise, a negative
number will be returned:</p>
<blockquote>
<table>
<tr valign="top">
<td>
<p><strong>-1</strong></p>
</td>
<td>
<p>invalid source file</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>-2</strong></p>
</td>
<td>
<p>invalid destination</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>-3</strong></p>
</td>
<td>
<p>destination file exists</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>-4</strong></p>
</td>
<td>
<p>no matches found</p>
</td>
</tr>
</table>
</blockquote>
<p><strong>Module:</strong> filesys</p>
</dd>
<dt><strong><a name="cmd_getflags"></a>getflags <dir></strong></dt>
<dd>
<p><strong>Returns:</strong> the flags required to access a
directory</p>
<p><strong>Module:</strong> filesys</p>
</dd>
<dt><strong><a name="cmd_setflags"></a>setflags <dir> [<flags>
[channel]]</strong></dt>
<dd>
<p><strong>Description:</strong> sets the flags required to
access a directory</p>
<p><strong>Returns:</strong> 0 on success; -1 or -3 on failure</p>
<p><strong>Module:</strong> filesys</p>
</dd>
</dl>
</blockquote>
<p><a name="misc"></a>9. <strong>Miscellaneous commands</strong></p>
<blockquote>
<dl>
<dt><strong><a name="cmd_bind"></a>bind <type> <flags> <keyword/mask>
[proc-name]</strong></dt>
<dd>
<p><strong>Description:</strong> You can use the 'bind'
command to attach Tcl procedures to certain events. flags are the
flags the user must have to trigger the event (if applicable).
proc-name is the name of the Tcl procedure to call for this
command (see below for the format of the procedure call). If the
proc-name is omitted, no binding is added. Instead, the current
binding is returned (if it's stackable, a list of the current
bindings is returned).</p>
<p><strong>Returns:</strong> name of the command that was added,
or (if proc-name was omitted), a list of the current bindings for
this command</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_unbind"></a>unbind <type> <flags> <keyword/mask>
<proc-name></strong></dt>
<dd>
<p><strong>Description:</strong> removes a previously created
bind</p>
<p><strong>Returns:</strong> name of the command that was
removed</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_binds"></a>binds [type/mask]</strong></dt>
<dd>
<p><strong>Returns:</strong> a list of Tcl binds, each item in the
list is a sublist of five elements: {<type> <flags>
<name> <hits> <proc>}</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_logfile"></a>logfile [<modes> <channel>
<filename>]</strong></dt>
<dd>
<p><strong>Description:</strong> creates a new logfile, which will
log the modes given for the channel listed. If no logfile is
specified, a list of existing logfiles will be returned.
"*" indicates all channels. You can also change the
modes and channel of an existing logfile with this command.
Entering a blank mode and channel ("") makes the bot
stop logging there.</p>
<p><strong>Returns:</strong> filename of logfile created, or, if
no logfile is specified, a list of logfiles such as: {mco *
eggdrop.log} {jp #lame lame.log}</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_maskhost"></a>maskhost <nick!user@host>
[masktype]</strong></dt>
<dd>
<p><strong>Description:</strong> masks the given irc hostmask, so
that it can match a wider set of nick/user/host combinations. The
masktypes supported are compatible with mIRC's standard types.</p>
<p> Available types are: <br>
<blockquote>
<table>
<tr valign="top">
<td>
<p><strong>0</strong></p>
</td>
<td>
<p>*!user@host</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>1</strong></p>
</td>
<td>
<p>*!*user@host</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>2</strong></p>
</td>
<td>
<p>*!*@host</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>3</strong></p>
</td>
<td>
<p>*!*user@*.host</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>4</strong></p>
</td>
<td>
<p>*!*@*.host</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>5</strong></p>
</td>
<td>
<p>nick!user@host</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>6</strong></p>
</td>
<td>
<p>nick!*user@host</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>7</strong></p>
</td>
<td>
<p>nick!*@host</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>8</strong></p>
</td>
<td>
<p>nick!*user@*.host</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>9</strong></p>
</td>
<td>
<p>nick!*@*.host</p>
</td>
</tr>
</table>
</blockquote>
</p>
<p>You can also specify types from 10 to 19 which correspond to types
0 to 9, but instead of using a * wildcard to replace portions of the
host, only numbers in hostnames are replaced with the '?' wildcard.
Same is valid for types 20-29, but instead of '?', the '*' wildcard
will be used.</p>
<p><strong>Returns:</strong> masked hostmask for the string
given according to the masktype. </p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_timer"></a>timer <minutes> <tcl-command></strong></dt>
<dd>
<p><strong>Description:</strong> executes the given Tcl command
after a certain number of minutes have passed</p>
<p><strong>Returns:</strong> a timerID</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_utimer"></a>utimer <seconds> <tcl-command></strong></dt>
<dd>
<p><strong>Description:</strong> executes the given Tcl command
after a certain number of seconds have passed</p>
<p><strong>Returns:</strong> a timerID</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_timers"></a>timers</strong></dt>
<dd>
<p><strong>Returns:</strong> a list of active minutely timers.
Each entry in the list contains the number of minutes left till
activation, the command that will be executed, and the timerID.</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_utimers"></a>utimers</strong></dt>
<dd>
<p><strong>Returns:</strong> a list of active secondly timers.
Each entry in the list contains the number of minutes left till
activation, the command that will be executed, and the timerID.</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_killtimer"></a>killtimer <timerID></strong></dt>
<dd>
<p><strong>Description:</strong> removes a minutely timer from
the list</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_killutimer"></a>killutimer <timerID></strong></dt>
<dd>
<p><strong>Description:</strong> removes a secondly timer from
the list</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_unixtime"></a>unixtime</strong></dt>
<dd>
<p><strong>Returns:</strong> a long integer which represents the
number of seconds that have passed since 00:00 Jan 1, 1970 (GMT).</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_duration"></a>duration <seconds></strong></dt>
<dd>
<p><strong>Returns:</strong> the number of seconds converted
into years, weeks, days, hours, minutes, and seconds. 804600
seconds is turned into 1 week 2 days 7 hours 30 minutes.</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_strftime"></a>strftime <formatstring> [time]</strong></dt>
<dd>
<p><strong>Returns:</strong> a formatted string of time using
standard strftime format. If time is specified, the value of the
specified time is used. Otherwise, the current time is used.</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_ctime"></a>ctime <unixtime></strong></dt>
<dd>
<p><strong>Returns:</strong> a formatted date/time string based
on the current locale settings from the unixtime string given; for
example "Fri Aug 3 11:34:55 1973"</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_myip"></a>myip</strong></dt>
<dd>
<p><strong>Returns:</strong> a long number representing the
bot's IP address, as it might appear in (for example) a DCC
request</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_rand"></a>rand <limit></strong></dt>
<dd>
<p><strong>Returns:</strong> a random integer between 0 and
limit-1</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_control"></a>control <idx> <command></strong></dt>
<dd>
<p><strong>Description:</strong> removes an idx from the party line
and sends all future input to the Tcl command given. The command
will be called with two parameters: the idx and the input text.
The command should return 0 to indicate success and 1 to indicate
that it relinquishes control of the user back to the bot. If the
input text is blank (""), it indicates that the
connection has been dropped. Also, if the input text is blank,
never call killdcc on it, as it will fail with "invalid
idx".</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_sendnote"></a>sendnote <from> <to[@bot]>
<message></strong></dt>
<dd>
<p><strong>Description:</strong> simulates what happens when one
user sends a note to another</p>
<p><strong>Returns:</strong></p>
<blockquote>
<table>
<tr valign="top">
<td>
<p><strong>0</strong></p>
</td>
<td>
<p>the send failed</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>1</strong></p>
</td>
<td>
<p>the note was delivered locally or sent to another
bot</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>2</strong></p>
</td>
<td>
<p>the note was stored locally</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>3</strong></p>
</td>
<td>
<p>the user's notebox is too full to store a note</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>4</strong></p>
</td>
<td>
<p>a Tcl binding caught the note</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>5</strong></p>
</td>
<td>
<p>the note was stored because the user is away</p>
</td>
</tr>
</table>
</blockquote>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_link"></a>link [via-bot] <bot></strong></dt>
<dd>
<p><strong>Description:</strong> attempts to link to another bot
directly. If you specify a via-bot, it tells the via-bot to
attempt the link.</p>
<p><strong>Returns:</strong> 1 if the link will be attempted; 0
otherwise</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_unlink"></a>unlink <bot></strong></dt>
<dd>
<p><strong>Description:</strong> attempts to unlink a bot from
the botnet</p>
<p><strong>Returns:</strong> 1 on success; 0 otherwise</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_encrypt"></a>encrypt <key> <string></strong></dt>
<dd>
<p><strong>Returns:</strong> encrypted string (using the currently
loaded encryption module), encoded into ASCII using base-64</p>
<p><strong>Module:</strong> encryption</p>
</dd>
<dt><strong><a name="cmd_decrypt"></a>decrypt <key>
<encrypted-base64-string></strong></dt>
<dd>
<p><strong>Returns:</strong> decrypted string (using the
currently loaded encryption module)</p>
<p><strong>Module:</strong> encryption</p>
</dd>
<dt><strong><a name="cmd_encpass"></a>encpass <password></strong></dt>
<dd>
<p><strong>Returns:</strong> encrypted string (using the currently
loaded encryption module)</p>
<p><strong>Module:</strong> encryption</p>
</dd>
<dt><strong><a name="cmd_die"></a>die [reason]</strong></dt>
<dd>
<p><strong>Description:</strong> causes the bot to log a fatal
error and exit completely. If no reason is given,
"EXIT" is used.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_unames"></a>unames</strong></dt>
<dd>
<p><strong>Returns:</strong> the current operating system the
bot is using</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_dnslookup"></a>dnslookup <ip-address/hostname> <proc>
[[arg1] [arg2] ... [argN]]</strong></dt>
<dd>
<p><strong>Description:</strong> This issues an asynchronous dns
lookup request. The command will block if dns module is not loaded;
otherwise it will either return immediately or immediately call
the specified proc (e.g. if the lookup is already cached).</p>
<p>As soon as the request completes, the specified proc will be
called as follows: <proc> <ipaddress> <hostname>
<status> [[arg1] [arg2] ... [argN]]</p>
<p>status is 1 if the lookup was successful and 0 if it
wasn't. All additional parameters (called arg1, arg2 and argN
above) get appended to the proc's other parameters.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_md5"></a>md5 <string></strong></dt>
<dd>
<p><strong>Returns:</strong> the 128 bit MD5 message-digest of
the specified string</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_callevent"></a>callevent <event></strong></dt>
<dd>
<p><strong>Description:</strong> triggers the evnt bind manually
for a certain event. For example: callevent rehash.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_traffic"></a>traffic</strong></dt>
<dd>
<p><strong>Returns:</strong> a list of sublists containing
information about the bot's traffic usage in bytes. Each
sublist contains five elements: type, in-traffic today,
in-traffic total, out-traffic today, out-traffic total (in that
order).</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_modules"></a>modules</strong></dt>
<dd>
<p><strong>Returns:</strong> a list of sublists containing
information about the bot's currently loaded modules. Each
sublist contains three elements: module, version, and
dependencies. Each dependency is also a sublist containing the
module name and version.</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_loadmodule"></a>loadmodule <module></strong></dt>
<dd>
<p><strong>Description:</strong> attempts to load the specified
module.</p>
<p><strong>Returns:</strong> "Already loaded." if the
module is already loaded, "" if successful, or the
reason the module couldn't be loaded.</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_unloadmodule"></a>unloadmodule <module></strong></dt>
<dd>
<p><strong>Description:</strong> attempts to unload the specified
module.</p>
<p><strong>Returns:</strong> "No such module" if the
module is not loaded, "" otherwise.</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_loadhelp"></a>loadhelp <helpfile-name></strong></dt>
<dd>
<p><strong>Description:</strong> attempts to load the specified
help file from the help/ directory.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_unloadhelp"></a>unloadhelp <helpfile-name></strong></dt>
<dd>
<p><strong>Description:</strong> attempts to unload the specified
help file.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_reloadhelp"></a>reloadhelp</strong></dt>
<dd>
<p><strong>Description:</strong> reloads the bot's help
files.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_restart"></a>restart</strong></dt>
<dd>
<p><strong>Description:</strong> rehashes the bot, kills all
timers, reloads all modules, and reconnects the bot to the next
server in its list.</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_rehash"></a>rehash</strong></dt>
<dd>
<p><strong>Description:</strong> rehashes the bot</p>
<p><strong>Returns:</strong> nothing</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_stripcodes"></a>stripcodes <strip-flags> <string></strong></dt>
<dd>
<p><strong>Description:</strong> strips specified control characters
from the string given. strip-flags can be any combination of the
following:</p>
<blockquote>
<table>
<tr valign="top">
<td>
<p><strong>b</strong></p>
</td>
<td>
<p>remove all boldface codes</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>c</strong></p>
</td>
<td>
<p>remove all color codes</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>r</strong></p>
</td>
<td>
<p>remove all reverse video codes</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>u</strong></p>
</td>
<td>
<p>remove all underline codes</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>a</strong></p>
</td>
<td>
<p>remove all ANSI codes</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>g</strong></p>
</td>
<td>
<p>remove all ctrl-g (bell) codes</p>
</td>
</tr>
</table>
</blockquote>
<p><strong>Returns:</strong> the stripped string</p>
</dd>
<dt><strong><a name="cmd_matchaddr"></a>matchaddr <hostmask>
<address></strong></dt>
<dd>
<p><strong>Description:</strong> checks if the address matches the
hostmask given. The address should be in the form nick!user@host.</p>
<p><strong>Returns:</strong> 1 if the address matches the
hostmask, 0 otherwise.</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_matchcidr"></a>matchcidr <block>
<address> <prefix></strong></dt>
<dd>
<p><strong>Description:</strong> performs a cidr match on the
specified ip addresses. IPv6 is supported, if enabled at compile
time.</p>
<p><strong>Returns:</strong> 1 if the address matches the
block prefix, 0 otherwise.</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="cmd_matchstr"></a>matchstr <pattern>
<string></strong></dt>
<dd>
<p><strong>Description:</strong> checks if pattern matches string.
Only two wildcards are supported: '*' and '?'. Matching is
case-insensitive. This command is intended as a simplified
alternative to Tcl's string match.</p>
<p><strong>Returns:</strong> 1 if the pattern matches the string,
0 if it doesn't.</p>
<p><strong>Module:</strong> core</p>
</dd>
</dl>
</blockquote>
<p><a name="globvars"></a>10. <strong>Global variables</strong></p>
<blockquote>
<p><strong>NOTE:</strong> All config file variables are also global.</p>
<dl>
<dt><strong><a name="globvar_botnick"></a>botnick</strong></dt>
<dd>
<p><strong>Value:</strong> the current nickname the bot is using
(for example: "Valis", "Valis0", etc.)</p>
<p><strong>Module:</strong> server</p>
</dd>
<dt><strong><a name="globvar_botname"></a>botname</strong></dt>
<dd>
<p><strong>Value:</strong> the current nick!user@host that the
server sees (for example: "Valis!valis@crappy.com")</p>
<p><strong>Module:</strong> server</p>
</dd>
<dt><strong><a name="globvar_server"></a>server</strong></dt>
<dd>
<p><strong>Value:</strong> the current server's real name (what
server calls itself) and port bot is connected to (for example:
"irc.math.ufl.edu:6667") Note that this does not nececerilly match
the servers internet address.</p>
<p><strong>Module:</strong> server</p>
</dd>
<dt><strong><a name="globvar_serveraddress"></a>serveraddress</strong></dt>
<dd>
<p><strong>Value:</strong> the current server's internet address
(hostname or IP) and port bot is connected to. This will correspond
to the entry in server list (for example: "eu.undernet.org:6667").
Note that this does not necessarily match the name server calls
itself.</p>
<p><strong>Module:</strong> server</p>
</dd>
<dt><strong><a name="globvar_version"></a>version</strong></dt>
<dd>
<p><strong>Value:</strong> current bot version "1.1.2+pl1
1010201 pl1"; first item is the text version, second item
is a numerical version, and any following items are the names of
patches that have been added</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="globvar_numversion"></a>numversion</strong></dt>
<dd>
<p><strong>Value:</strong> the current numeric bot version (for
example: "1010201"). Numerical version is in the format
of "MNNRRPP", where:</p>
<blockquote>
<table>
<tr valign="top">
<td>
<p><strong>M</strong></p>
</td>
<td>
<p>major release number</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>NN</strong></p>
</td>
<td>
<p>minor release number</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>RR</strong></p>
</td>
<td>
<p>sub-release number</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>PP</strong></p>
</td>
<td>
<p>patch level for that sub-release</p>
</td>
</tr>
</table>
</blockquote>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="globvar_uptime" id="globvar_uptime"></a>uptime</strong></dt>
<dd>
<p><strong>Value:</strong> the unixtime value for when the bot
was started</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="globvar_server-online"></a>server-online</strong></dt>
<dd>
<p><strong>Value:</strong> the unixtime value for when the bot
connected to its current server</p>
<p><strong>Module:</strong> server</p>
</dd>
<dt><strong><a name="globvar_lastbind"></a>lastbind</strong></dt>
<dd>
<p><strong>Value:</strong> the last command binding which was
triggered. This allows you to identify which command triggered
a Tcl proc.</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="globvar_isjuped"></a>isjuped</strong></dt>
<dd>
<p><strong>Value:</strong> 1 if bot's nick is juped(437);
0 otherwise</p>
<p><strong>Module:</strong> server</p>
</dd>
<dt><strong><a name="globvar_handlen"></a>handlen</strong></dt>
<dd>
<p><strong>Value:</strong> the value of the HANDLEN define in
src/eggdrop.h</p>
<p><strong>Module:</strong> core</p>
</dd>
<dt><strong><a name="globvar_config"></a>config</strong></dt>
<dd>
<p><strong>Value:</strong> the filename of the config file Eggdrop
is currently using</p>
<p><strong>Module:</strong> core</p>
</dd>
</dl>
</blockquote>
<p><a name="bind"></a>11. <strong>Bind</strong></p>
<blockquote>
<p>You can use the 'bind' command to attach Tcl procedures
to certain events. For example, you can write a Tcl procedure that
gets called every time a user says "danger" on the
channel.</p>
<p>Some bind types are marked as "stackable". That means
that you can bind multiple commands to the same trigger. Normally, for
example, a bind such as 'bind msg - stop msg:stop' (which
makes a msg-command "stop" call the Tcl proc
"msg:stop") will overwrite any previous binding you had for
then msg command "stop". With stackable bindings, like
'msgm' for example, you can bind the same command to multiple
procs. When the bind is triggered, ALL of the Tcl procs that are
bound to it will be called.</p>
<p>To remove a bind, use the 'unbind' command. For example,
to remove the bind for the "stop" msg command, use
'unbind msg - stop msg:stop'.</p>
<ol type="A">
<li>
<p><a name="binda"></a><strong>Bind types</strong></p>
<ol>
<li>
<p><a name="binda_msg"></a><strong>MSG</strong></p>
<p><strong>bind msg <flags> <command>
<proc><br>
procname <nick> <user@host> <handle>
<text></strong></p>
<p><strong>Description:</strong> used for /msg commands. The
first word of the user's msg is the command, and
everything else becomes the text argument.</p>
<p><strong>Module:</strong> server</p>
</li>
<li>
<p><a name="binda_dcc"></a><strong>DCC</strong></p>
<p><strong>bind dcc <flags> <command>
<proc><br>
procname <handle> <idx> <text></strong></p>
<p><strong>Description:</strong> used for partyline commands;
the command is the first word and everything else becomes
the text argument. The idx is valid until the user disconnects.
After that, it may be reused, so be careful about storing an
idx for long periods of time.</p>
<p><strong>Module:</strong> core</p>
</li>
<li>
<p><a name="binda_fil"></a><strong>FIL</strong></p>
<p><strong>bind fil <flags> <command>
<proc><br>
procname <handle> <idx> <text></strong></p>
<p><strong>Description:</strong> the same as DCC, except this
is triggered if the user is in the file area instead of the
party line</p>
<p><strong>Module:</strong> filesys</p>
</li>
<li>
<p><a name="binda_pub"></a><strong>PUB</strong></p>
<p><strong>bind pub <flags> <command>
<proc><br>
procname <nick> <user@host> <handle>
<channel> <text></strong></p>
<p><strong>Description:</strong> used for commands given on
a channel. The first word becomes the command and everything
else is the text argument.</p>
<p><strong>Module:</strong> irc</p>
</li>
<li>
<p><a name="binda_msgm"></a><strong>MSGM (stackable)</strong></p>
<p><strong>bind msgm <flags> <mask>
<proc><br>
procname <nick> <user@host> <handle>
<text></strong></p>
<p><strong>Description:</strong> matches the entire line of
text from a /msg with the mask. This is useful for binding
Tcl procs to words or phrases spoken anywhere within a line
of text. If the proc returns 1, Eggdrop will not log the
message that triggered this bind. MSGM binds are processed
before MSG binds. If the exclusive-binds setting is enabled,
MSG binds will not be triggered by text that a MSGM bind has
already handled.</p>
<p><strong>Module:</strong> server</p>
</li>
<li>
<p><a name="binda_pubm"></a><strong>PUBM (stackable)</strong></p>
<p><strong>bind pubm <flags> <mask>
<proc><br>
procname <nick> <user@host> <handle>
<channel> <text></strong></p>
<p><strong>Description:</strong> just like MSGM, except
it's triggered by things said on a channel instead of
things /msg'd to the bot. The mask is matched against
the channel name followed by the text and can contain
wildcards. If the proc returns 1, Eggdrop will not log
the message that triggered this bind. PUBM binds are
processed before PUB binds. If the exclusive-binds setting
is enabled, PUB binds will not be triggered by text that a
PUBM bind has already handled.</p>
<p><strong>Module:</strong> irc</p>
</li>
<li>
<p><a name="binda_notc"></a><strong>NOTC (stackable)</strong></p>
<p><strong>bind notc <flags> <mask> <proc><br>
procname <nick> <user@host> <handle>
<text> <dest></strong></p>
<p><strong>Description:</strong> dest will be a nickname (the
bot's nickname, obviously) or a channel name. mask is
matched against the entire notice and can contain wildcards.
It is considered a breach of protocol to respond to a /notice
on IRC, so this is intended for internal use (logging, etc.)
only. Note that server notices do not trigger the NOTC bind.
If the proc returns 1, Eggdrop will not log the message that
triggered this bind.</p>
<p>New Tcl procs should be declared as</p>
<pre>
proc notcproc {nick uhost hand text {dest ""}} {
global botnick; if {$dest == ""} {set dest $botnick}
...
}
</pre>
<p>for compatibility.</p>
<p><strong>Module:</strong> server</p>
</li>
<li>
<p><a name="binda_join"></a><strong>JOIN (stackable)</strong></p>
<p><strong>bind join <flags> <mask> <proc><br>
procname <nick> <user@host> <handle>
<channel></strong></p>
<p><strong>Description:</strong> triggered by someone joining
the channel. The mask in the bind is matched against
"#channel nick!user@host" and can contain
wildcards.</p>
<p><strong>Module:</strong> irc</p>
</li>
<li>
<p><a name="binda_part"></a><strong>PART (stackable)</strong></p>
<p><strong>bind part <flags> <mask> <proc><br>
procname <nick> <user@host> <handle>
<channel> <msg></strong></p>
<p><strong>Description:</strong> triggered by someone leaving
the channel. The mask is matched against "#channel
nick!user@host" and can contain wildcards. If no part
message is specified, msg will be set to "".</p>
<p>New Tcl procs should be declared as</p>
<pre>
proc partproc {nick uhost hand chan {msg ""}} { ... }
</pre>
<p>for compatibility.</p>
<p><strong>Module:</strong> irc</p>
</li>
<li>
<p><a name="binda_sign"></a><strong>SIGN (stackable)</strong></p>
<p><strong>bind sign <flags> <mask> <proc><br>
procname <nick> <user@host> <handle>
<channel> <reason></strong></p>
<p><strong>Description:</strong> triggered by a signoff, or
possibly by someone who got netsplit and never returned. The
signoff message is the last argument to the proc. Wildcards
can be used in the mask, which is matched against '#channel
nick!user@host'.</p>
<p><strong>Module:</strong> irc</p>
</li>
<li>
<p><a name="binda_topc"></a><strong>TOPC (stackable)</strong></p>
<p><strong>bind topc <flags> <mask> <proc><br>
procname <nick> <user@host> <handle>
<channel> <topic></strong></p>
<p><strong>Description:</strong> triggered by a topic change.
mask can contain wildcards and is matched against '#channel
<new topic>'.</p>
<p><strong>Module:</strong> irc</p>
</li>
<li>
<p><a name="binda_kick"></a><strong>KICK (stackable)</strong></p>
<p><strong>bind kick <flags> <mask> <proc><br>
procname <nick> <user@host> <handle>
<channel> <target> <reason></strong></p>
<p><strong>Description:</strong> triggered when someone is
kicked off the channel. The mask is matched against
'#channel target reason' where the target is the nickname of
the person who got kicked (can contain wildcards). The proc
is called with the nick, user@host, and handle of the kicker,
plus the channel, the nickname of the person who was kicked,
and the reason.</p>
<p><strong>Module:</strong> irc</p>
</li>
<li>
<p><a name="binda_nick"></a><strong>NICK (stackable)</strong></p>
<p><strong>bind nick <flags> <mask> <proc><br>
procname <nick> <user@host> <handle>
<channel> <newnick></strong></p>
<p><strong>Description:</strong> triggered when someone changes
nicknames. The mask is matched against '#channel newnick'
and can contain wildcards. Channel is "*" if the user isn't
on a channel (usually the bot not yet in a channel).</p>
<p><strong>Module:</strong> irc</p>
</li>
<li>
<p><a name="binda_mode"></a><strong>MODE (stackable)</strong></p>
<p><strong>bind mode <flags> <mask> <proc><br>
proc-name <nick> <user@host> <handle>
<channel> <mode-change> <target></strong></p>
<p><strong>Description:</strong> mode changes are broken down
into their component parts before being sent here, so the
<mode-change> will always be a single mode, such as
"+m" or "-o". target will show the argument
of the mode change (for o/v/b/e/I) or "" if the set
mode does not take an argument. The bot's automatic
response to a mode change will happen AFTER all matching Tcl
procs are called. The mask will be matched against
'#channel +/-modes' and can contain wildcards.</p>
<p>If it is a server mode, nick will be "", user@host
is the server name, and handle is *.</p>
<p>Note that "target" was added in 1.3.17 and that
this will break Tcl scripts that were written for pre-1.3.17
Eggdrop that use the mode binding. Also, due to a typo, mode
binds were broken completely in 1.3.17 but were fixed in
1.3.18. Mode bindings are not triggered at all in 1.3.17.</p>
<p>One easy example (from guppy) of how to support the
"target" parameter in 1.3.18 and later and still
remain compatible with older Eggdrop versions is:</p>
<p>Old script looks as follows:</p>
<pre>
bind mode - * mode_proc
proc mode_proc {nick uhost hand chan mode} { ... }
</pre>
<p>To make it work with 1.3.18+ and stay compatible with older
bots, do:</p>
<pre>
bind mode - * mode_proc_fix
proc mode_proc_fix {nick uhost hand chan mode {target ""}} {
if {$target != ""} {append mode " $target"}
mode_proc $nick $uhost $hand $chan $mode
}
proc mode_proc {nick uhost hand chan mode} { ... }
</pre>
<p><strong>Module:</strong> irc</p>
</li>
<li>
<p><a name="binda_ctcp"></a><strong>CTCP (stackable)</strong></p>
<p><strong>bind ctcp <flags> <keyword>
<proc><br>
proc-name <nick> <user@host> <handle>
<dest> <keyword> <text></strong></p>
<p><strong>Description:</strong> dest will be a nickname (the
bot's nickname, obviously) or channel name. keyword is
the ctcp command (which can contain wildcards), and text may
be empty. If the proc returns 0, the bot will attempt its
own processing of the ctcp command.</p>
<p><strong>Module:</strong> server</p>
</li>
<li>
<p><a name="binda_ctcr"></a><strong>CTCR (stackable)</strong></p>
<p><strong>bind ctcr <flags> <keyword>
<proc><br>
proc-name <nick> <user@host> <handle>
<dest> <keyword> <text></strong></p>
<p><strong>Description:</strong> just like ctcp, but this is
triggered for a ctcp-reply (ctcp embedded in a notice instead
of a privmsg)</p>
<p><strong>Module:</strong> server</p>
</li>
<li>
<p><a name="binda_raw"></a><strong>RAW (stackable)</strong></p>
<p><strong>bind raw <flags> <keyword-mask>
<proc><br>
procname <from> <keyword> <text></strong></p>
<p><strong>Description:</strong> previous versions of Eggdrop
required a special compile option to enable this binding, but
it's now standard. The keyword is either a numeric, like
"368", or a keyword, such as "PRIVMSG". from
will be the server name or the source user (depending on the
keyword); flags are ignored. The order of the arguments is
identical to the order that the IRC server sends to the bot. The
pre-processing only splits it apart enough to determine the
keyword. If the proc returns 1, Eggdrop will not process the line
any further (this could cause unexpected behavior in some
cases).</p>
<p><strong>Module:</strong> server</p>
</li>
<li>
<p><a name="binda_bot"></a><strong>BOT</strong></p>
<p><strong>bind bot <flags> <command>
<proc><br>
proc-name <from-bot> <command>
<text></strong></p>
<p><strong>Description:</strong> triggered by a message coming
from another bot in the botnet. The first word is the command
and the rest becomes the text argument; flags are ignored.</p>
<p><strong>Module:</strong> core</p>
</li>
<li>
<p><a name="binda_chon"></a><strong>CHON (stackable)</strong></p>
<p><strong>bind chon <flags> <mask> <proc><br>
proc-name <handle> <idx></strong></p>
<p><strong>Description:</strong> when someone first enters the
party-line area of the bot via dcc chat or telnet, this is
triggered before they are connected to a chat channel (so,
yes, you can change the channel in a 'chon' proc).
mask is matched against the handle and supports wildcards.
This is NOT triggered when someone returns from the file area,
etc.</p>
<p><strong>Module:</strong> core</p>
</li>
<li>
<p><a name="binda_chof"></a><strong>CHOF (stackable)</strong></p>
<p><strong>bind chof <flags> <mask> <proc><br>
proc-name <handle> <idx></strong></p>
<p><strong>Description:</strong> triggered when someone leaves
the party line to disconnect from the bot. mask is matched
against the handle and can contain wildcards. Note that the
connection may have already been dropped by the user, so
don't send output to the idx.</p>
<p><strong>Module:</strong> core</p>
</li>
<li>
<p><a name="binda_sent"></a><strong>SENT (stackable)</strong></p>
<p><strong>bind sent <flags> <mask> <proc><br>
proc-name <handle> <nick>
<path/to/file></strong></p>
<p><strong>Description:</strong> after a user has successfully
downloaded a file from the bot, this binding is triggered. mask
is matched against the handle of the user that initiated the
transfer and supports wildcards. nick is the actual recipient
(on IRC) of the file. The path is relative to the dcc
directory (unless the file transfer was started by a script
call to 'dccsend', in which case the path is the
exact path given in the call to 'dccsend').</p>
<p><strong>Module:</strong> transfer</p>
</li>
<li>
<p><a name="binda_rcvd"></a><strong>RCVD (stackable)</strong></p>
<p><strong>bind rcvd <flags> <mask> <proc><br>
proc-name <handle> <nick>
<path/to/file></strong></p>
<p><strong>Description:</strong> triggered after a user
uploads a file successfully. mask is matched against the
user's handle. nick is the IRC nickname that the file
transfer originated from. The path is where the file ended
up, relative to the dcc directory (usually this is your
incoming dir).</p>
<p><strong>Module:</strong> transfer</p>
</li>
<li>
<p><a name="binda_chat"></a><strong>CHAT (stackable)</strong></p>
<p><strong>bind chat <flags> <mask> <proc><br>
proc-name <handle> <channel#>
<text></strong></p>
<p><strong>Description:</strong> when a user says something on
the botnet, it invokes this binding. Flags are ignored; handle
could be a user on this bot ("DronePup") or on
another bot ("Eden@Wilde") and therefore you can't
rely on a local user record. The mask is checked against the
entire line of text and supports wildcards.</p>
<p><strong>NOTE:</strong> If a BOT says something on the botnet,
the BCST bind is invoked instead.</p>
<p><strong>Module:</strong> core</p>
</li>
<li>
<p><a name="binda_link"></a><strong>LINK (stackable)</strong></p>
<p><strong>bind link <flags> <mask> <proc><br>
proc-name <botname> <via></strong></p>
<p><strong>Description:</strong> triggered when a bot links
into the botnet. botname is the botnetnick of the bot that
just linked in; via is the bot it linked through. The mask
is checked against the botnetnick of the bot that linked and
supports wildcards. flags are ignored.</p>
<p><strong>Module:</strong> core</p>
</li>
<li>
<p><a name="binda_disc"></a><strong>DISC (stackable)</strong></p>
<p><strong>bind disc <flags> <mask> <proc><br>
proc-name <botname></strong></p>
<p><strong>Description:</strong> triggered when a bot
disconnects from the botnet for whatever reason. Just like
the link bind, flags are ignored; mask is matched against
the botnetnick of the bot that unlinked. Wildcards are
supported in mask.</p>
<p><strong>Module:</strong> core</p>
</li>
<li>
<p><a name="binda_splt"></a><strong>SPLT (stackable)</strong></p>
<p><strong>bind splt <flags> <mask> <proc><br>
procname <nick> <user@host> <handle>
<channel></strong></p>
<p><strong>Description:</strong> triggered when someone gets
netsplit on the channel. Be aware that this may be a false
alarm (it's easy to fake a netsplit signoff message on
some networks); mask may contain wildcards and is matched
against '#channel nick!user@host'. Anyone who is SPLT
will trigger a REJN or SIGN within the next wait-split
(defined in the config file) minutes.</p>
<p><strong>Module:</strong> irc</p>
</li>
<li>
<p><a name="binda_rejn"></a><strong>REJN (stackable)</strong></p>
<p><strong>bind rejn <flags> <mask> <proc><br>
procname <nick> <user@host> <handle>
<channel></strong></p>
<p><strong>Description:</strong> someone who was split has
rejoined. mask can contain wildcards, and is matched against
'#channel nick!user@host'.</p>
<p><strong>Module:</strong> irc</p>
</li>
<li>
<p><a name="binda_filt"></a><strong>FILT (stackable)</strong></p>
<p><strong>bind filt <flags> <mask> <proc><br>
procname <idx> <text></strong></p>
<p><strong>Description:</strong> party line and file system
users have their text sent through filt before being
processed. If the proc returns a blank string, the text is
considered parsed. Otherwise, the bot will use the text
returned from the proc and continue parsing that.</p>
<p><strong>Module:</strong> core</p>
</li>
<li>
<p><a name="binda_need"></a><strong>NEED (stackable)</strong></p>
<p><strong>bind need <flags> <mask> <proc><br>
procname <channel> <type></strong></p>
<p><strong>Description:</strong> this bind is triggered on
certain events, like when the bot needs operator status or
the key for a channel. The types are: op, unban, invite,
limit, and key; the mask is matched against '#channel
type' and can contain wildcards. flags are ignored.</p>
<p>Example:</p>
<p>bind need - "% op" needop < handles only need
op<br>
bind need - "*" needall < handles all needs</p>
<p><strong>Module:</strong> irc</p>
</li>
<li>
<p><a name="binda_flud"></a><strong>FLUD (stackable)</strong></p>
<p><strong>bind flud <flags> <type> <proc><br>
procname <nick> <user@host> <handle>
<type> <channel></strong></p>
<p><strong>Description:</strong> any floods detected through
the flood control settings (like 'flood-ctcp') are
sent here before processing. If the proc returns 1, no
further action is taken on the flood; if the proc returns 0,
the bot will do its normal "punishment" for the
flood. The flood types are: pub, msg, join, or ctcp (and can
be masked to "*" for the bind); flags are ignored.</p>
<p><strong>Module:</strong> server</p>
</li>
<li>
<p><a name="binda_note"></a><strong>NOTE (stackable)</strong></p>
<p><strong>bind note <flags> <mask> <proc><br>
procname <from> <to> <text></strong></p>
<p><strong>Description:</strong> incoming notes (either from
the party line, someone on IRC, or someone on another bot on
the botnet) are checked against these binds before being
processed. The mask is matched against the receiving handle
and supports wildcards. If the proc returns 1, Eggdrop will
not process the note any further. Flags are ignored.</p>
<p><strong>Module:</strong> core</p>
</li>
<li>
<p><a name="binda_act"></a><strong>ACT (stackable)</strong></p>
<p><strong>bind act <flags> <mask> <proc><br>
proc-name <handle> <channel#>
<action></strong></p>
<p><strong>Description:</strong> when someone does an action
on the botnet, it invokes this binding. flags are ignored;
the mask is matched against the text of the action and can
support wildcards.</p>
<p><strong>Module:</strong> core</p>
</li>
<li>
<p><a name="binda_wall"></a><strong>WALL (stackable)</strong></p>
<p><strong>bind wall <flags> <mask> <proc><br>
proc-name <handle> <msg></strong></p>
<p><strong>Description:</strong> when the bot receives a
wallops, it invokes this binding. flags are ignored; the mask
is matched against the text of the wallops msg. Note that RFC
shows the server name as a source of the message, whereas many
IRCds send the nick!user@host of the actual sender, thus,
Eggdrop will not parse it at all, but simply pass it to bind
in its original form. If the proc returns 1, Eggdrop will not
log the message that triggered this bind.</p>
<p><strong>Module:</strong> server</p>
</li>
<li>
<p><a name="binda_bcst"></a><strong>BCST (stackable)</strong></p>
<p><strong>bind bcst <flags> <mask> <proc><br>
proc-name <botname> <channel#>
<text></strong></p>
<p><strong>Description:</strong> when a bot broadcasts something
on the botnet (see 'dccbroadcast' above), it invokes
this binding. flags are ignored; the mask is matched against
the message text and can contain wildcards. 'channel'
argument will always be '-1' since broadcasts are not
directed to any partyline channel.</p>
<p>It is also invoked when a BOT (not a person, as with the CHAT
bind) 'says' something on a channel. In this case, the
'channel' argument will be a valid channel, and not
'-1'.
<p><strong>Module:</strong> core</p>
</li>
<li>
<p><a name="binda_chjn"></a><strong>CHJN (stackable)</strong></p>
<p><strong>bind chjn <flags> <mask> <proc><br>
proc-name <botname> <handle> <channel#>
<flag> <idx> <user@host></strong></p>
<p><strong>Description:</strong> when someone joins a botnet
channel, it invokes this binding. The mask is matched against
the channel and can contain wildcards. flag is one of: *
(owner), + (master), @ (op), or % (botnet master).
Flags are ignored.</p>
<p><strong>Module:</strong> core</p>
</li>
<li>
<p><a name="binda_chpt"></a><strong>CHPT (stackable)</strong></p>
<p><strong>bind chpt <flags> <mask> <proc><br>
proc-name <botname> <handle> <idx>
<channel#></strong></p>
<p><strong>Description:</strong> when someone parts a botnet
channel, it invokes this binding. The mask is matched against
the channel and can contain wildcards. Flags are ignored.</p>
<p><strong>Module:</strong> core</p>
</li>
<li>
<p><a name="binda_time"></a><strong>TIME (stackable)</strong></p>
<p><strong>bind time <flags> <mask> <proc><br>
proc-name <minute> <hour> <day> <month>
<year></strong></p>
<p><strong>Description:</strong> allows you to schedule
procedure calls at certain times. mask matches 5 space
separated integers of the form: "minute hour day month
year". minute, hour, day, month have a zero padding so
they are exactly two characters long; year is four characters.
Flags are ignored.</p>
<p><strong>Module:</strong> core</p>
</li>
<li>
<p><a name="binda_away"></a><strong>AWAY (stackable)</strong></p>
<p><strong>bind away <flags> <mask> <proc><br>
proc-name <botname> <idx> <text></strong></p>
<p><strong>Description:</strong> triggers when a user goes
away or comes back on the botnet. text is the reason than has
been specified (text is "" when returning). mask is
matched against the botnet-nick of the bot the user is
connected to and supports wildcards. flags are ignored.</p>
<p><strong>Module:</strong> core</p>
</li>
<li>
<p><a name="binda_load"></a><strong>LOAD (stackable)</strong></p>
<p><strong>bind load <flags> <mask> <proc><br>
proc-name <module></strong></p>
<p><strong>Description:</strong> triggers when a module is
loaded. mask is matched against the name of the loaded module
and supports wildcards; flags are ignored.</p>
<p><strong>Module:</strong> core</p>
</li>
<li>
<p><a name="binda_unld"></a><strong>UNLD (stackable)</strong></p>
<p><strong>bind unld <flags> <mask> <proc><br>
proc-name <module></strong></p>
<p><strong>Description:</strong> triggers when a module is
unloaded. mask is matched against the name of the unloaded
module and supports wildcards; flags are ignored.</p>
<p><strong>Module:</strong> core</p>
</li>
<li>
<p><a name="binda_nkch"></a><strong>NKCH (stackable)</strong></p>
<p><strong>bind nkch <flags> <mask> <proc><br>
proc-name <oldhandle> <newhandle></strong></p>
<p><strong>Description:</strong> triggered whenever a local
user's handle is changed (in the userfile). mask is
matched against the user's old handle and can contain
wildcards; flags are ignored.</p>
<p><strong>Module:</strong> core</p>
</li>
<li>
<p><a name="binda_evnt"></a><strong>EVNT (stackable)</strong></p>
<p><strong>bind evnt <flags> <type> <proc><br>
proc-name <type></strong></p>
<p><strong>Description:</strong> Description: triggered whenever
one of these events happen; flags are ignored; valid events
are:</p>
<blockquote>
<table>
<tr valign="top">
<td>
<p><strong>sighup</strong></p>
</td>
<td>
<p>called on a kill -HUP <pid></p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>sigterm</strong></p>
</td>
<td>
<p>called on a kill -TERM <pid></p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>sigill</strong></p>
</td>
<td>
<p>called on a kill -ILL <pid></p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>sigquit</strong></p>
</td>
<td>
<p>called on a kill -QUIT <pid></p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>save</strong></p>
</td>
<td>
<p>called when the userfile is saved</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>rehash</strong></p>
</td>
<td>
<p>called just after a rehash</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>prerehash</strong></p>
</td>
<td>
<p>called just before a rehash</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>prerestart</strong></p>
</td>
<td>
<p>called just before a restart</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>logfile</strong></p>
</td>
<td>
<p>called when the logs are switched daily</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>loaded</strong></p>
</td>
<td>
<p>called when the bot is done loading</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>userfile-loaded</strong></p>
</td>
<td>
<p>called after userfile has been loaded</p>
</td>
</tr>
</table>
</blockquote>
<blockquote>
<table>
<tr valign="top">
<td>
<p><strong>connect-server</strong></p>
</td>
<td>
<p>called just before we connect to an IRC server</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>init-server</strong></p>
</td>
<td>
<p>called when we actually get on our IRC server</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>disconnect-server</strong></p>
</td>
<td>
<p>called when we disconnect from our IRC server</p>
</td>
</tr>
</table>
</blockquote>
<p><strong>Module:</strong> core</p>
</li>
<li>
<p><a name="binda_lost"></a><strong>LOST (stackable)</strong></p>
<p><strong>bind lost <flags> <mask> <proc><br>
proc-name <handle> <nick> <path>
<bytes-transferred> <length-of-file></strong></p>
<p><strong>Description:</strong> triggered when a DCC SEND
transfer gets lost, such as when the connection is
terminated before all data was successfully sent/received.
This is typically caused by a user abort.</p>
<p><strong>Module:</strong> transfer</p>
</li>
<li>
<p><a name="binda_tout"></a><strong>TOUT (stackable)</strong></p>
<p><strong>bind tout <flags> <mask> <proc><br>
proc-name <handle> <nick> <path>
<bytes-transferred> <length-of-file></strong></p>
<p><strong>Description:</strong> triggered when a DCC SEND
transfer times out. This may either happen because the dcc
connection was not accepted or because the data transfer
stalled for some reason.</p>
<p><strong>Module:</strong> transfer</p>
</li>
<li>
<p><a name="binda_out"></a><strong>OUT (stackable)</strong></p>
<p><strong>bind out <flags> <mask> <proc><br>
proc-name <queue> <text> <queued|sent>
</strong></p>
<p><strong>Description:</strong> triggered whenever output is sent
to the server. Normally the event will occur twice for each line
sent: once before entering a server queue and once after the
message is actually sent. This allows for more flexible logging of
server output and introduces the ability to cancel messages.
Mask is matched against "queue status", where status is either
'queued' or 'sent'. Queues are: mode, server, help, noqueue.
noqueue is only used by the putnow tcl command.</p>
<p><strong>Module:</strong> server</p>
</li>
<li>
<p><a name="binda_cron"></a><strong>CRON (stackable)</strong></p>
<p><strong>bind cron <flags> <mask> <proc><br>
proc-name <minute> <hour> <day> <month>
<weekday></strong></p>
<p><strong>Description:</strong> similar to bind TIME, but the
mask is evaluated as a cron expression, e.g.
"16/2 */2 5-15 7,8,9 4". It can contain up to five
fields: minute, hour, day, month, weekday; delimited by
whitespace. Week days are represented as 0-6, except Sunday
which can be either 0 or 7. Symbolic names are not supported. The
bind will be triggered if the mask matches all of the fields,
except that if both day and weekday are not '*', only one of them
is required to match. If any number of fields are omitted at the
end, the match will proceed as if they were '*'. All cron
operators are supported. Please refer to the crontab manual for
their meanings. Flags are ignored.</p>
<p><strong>Module:</strong> core</p>
</li>
<li>
<p><a name="binda_log"></a><strong>LOG (stackable)</strong></p>
<p><strong>bind log <flags> <mask> <proc><br>
proc-name <level> <channel> <message></strong>
</p>
<p><strong>Description:</strong> triggered whenever a message
is sent to a log. The mask is matched against "channel
text". The level argument to the proc will contain the
level(s) the message is sent to, or '*' if the message is sent
to all log levels at once. If the message wasn't sent to a
specific channel, channel will be set to '*'.</p>
<p><strong>Module:</strong> core</p>
</li>
</ol>
</li>
<li>
<p><a name="bindb"></a><strong>Return Values</strong></p>
<p>Several bindings pay attention to the value you return from
the proc (using 'return <value>'). Usually, they
expect a 0 or 1, and returning an empty return is interpreted
as a 0. Be aware if you omit the return statement, the result
of the last Tcl command executed will be returned by the proc.
This will not likely produce the results you intended (this is
a "feature" of Tcl).</p>
<p>Here's a list of the bindings that use the return value
from procs they trigger:</p>
<ol>
<li>
<p><a name="bindb_msg"></a><strong>MSG</strong></p>
<p>Return 1 to make Eggdrop log the command as:</p>
<blockquote>
<p>(nick!user@host) !handle! command</p>
</blockquote>
</li>
<li>
<p><a name="bindb_dcc"></a><strong>DCC</strong></p>
<p>Return 1 to make Eggdrop log the command as:</p>
<blockquote>
<p>#handle# command</p>
</blockquote>
</li>
<li>
<p><a name="bindb_fil"></a><strong>FIL</strong></p>
<p>Return 1 to make Eggdrop log the command as:</p>
<blockquote>
<p>#handle# files: command</p>
</blockquote>
</li>
<li>
<p><a name="bindb_pub"></a><strong>PUB</strong></p>
<p>Return 1 to make Eggdrop log the command as:</p>
<blockquote>
<p><<nick>> !handle! command</p>
</blockquote>
</li>
<li>
<p><a name="bindb_ctcp"></a><strong>CTCP</strong></p>
<p>Return 1 to ask the bot not to process the CTCP command on
its own. Otherwise, it would send its own response to the CTCP
(possibly an error message if it doesn't know how to deal
with it).</p>
</li>
<li>
<p><a name="bindb_filt"></a><strong>FILT</strong></p>
<p>Return "" to indicate the text has been processed, and the
bot should just ignore it. Otherwise, it will treat the text
like any other.</p>
</li>
<li>
<p><a name="bindb_flud"></a><strong>FLUD</strong></p>
<p>Return 1 to ask the bot not to take action on the flood.
Otherwise it will do its normal punishment.</p>
</li>
<li>
<p><a name="bindb_raw"></a><strong>RAW</strong></p>
<p>Return 1 to ask the bot not to process the server text.
This can affect the bot's performance by causing it to
miss things that it would normally act on -- you have been
warned.</p>
</li>
<li>
<p><a name="bindb_chon"></a><strong>CHON</strong></p>
<p>Return 1 to ask the bot not to process the partyline join
event.</p>
</li>
<li>
<p><a name="bindb_chof"></a><strong>CHOF</strong></p>
<p>Return 1 to ask the bot not to process the partyline part
event.</p>
</li>
<li>
<p><a name="bindb_wall"></a><strong>WALL</strong></p>
<p>Return 1 to make Eggdrop not log the message that
triggered this bind.</p>
</li>
<li>
<p><a name="bindb_note"></a><strong>NOTE</strong></p>
<p>Return 1 to make Eggdrop not process the note any
further. This includes stacked note bindings that would
be processed after this one, as well as the built-in
eggdrop note handling routines.</p>
</li>
<li>
<p><a name="bindb_msgm"></a><strong>MSGM</strong></p>
<p>Return 1 to make Eggdrop not log the message that
triggered this bind.</p>
</li>
<li>
<p><a name="bindb_pubm"></a><strong>PUBM</strong></p>
<p>Return 1 to make Eggdrop not log the message that
triggered this bind.</p>
</li>
<li>
<p><a name="bindb_notc"></a><strong>NOTC</strong></p>
<p>Return 1 to make Eggdrop not log the message that
triggered this bind.</p>
</li>
<li>
<p><a name="bindb_out"></a><strong>OUT</strong></p>
<p>Return 1 to make Eggdrop drop the message instead of
sending it. Only meaningful for messages with status
"queued".</p>
</li>
</ol>
</li>
</ol>
</blockquote>
<p><a name="control"></a>12. <strong>Control procedures</strong></p>
<blockquote>
<p>Using the 'control' command, you can put a DCC connection
(or outgoing TCP connection) in control of a script. All text received
from the connection is sent to the proc you specify. All outgoing text
should be sent with 'putdcc'.</p>
<p>The control procedure is called with these parameters:</p>
<blockquote>
<p>procname <idx> <input-text></p>
</blockquote>
<p>This allows you to use the same proc for several connections. The
idx will stay the same until the connection is dropped. After that,
it will probably get reused for a later connection.</p>
<p>To indicate that the connection has closed, your control procedure
will be called with blank text (the input-text will be "").
This is the only time it will ever be called with "" as the
text, and it is the last time your proc will be called for that
connection. Don't call killdcc on the idx when text is blank, it
will always fail with "invalid idx".</p>
<p>If you want to hand control of your connection back to Eggdrop,
your proc should return 1. Otherwise, return 0 to retain
control.</p>
</blockquote>
<p><a name="tcp"></a>13. <strong>TCP connections</strong></p>
<blockquote>
<p>Eggdrop allows you to make two types of TCP ("telnet")
connections: outgoing and incoming. For an outgoing connection, you
specify the remote host and port to connect to. For an incoming
connection, you specify a port to listen on.</p>
<p>All of the connections are *event driven*. This means that the bot
will trigger your procs when something happens on the connection, and
your proc is expected to return as soon as possible. Waiting in a proc
for more input is a no-no.</p>
<p>To initiate an outgoing connection, use:</p>
<blockquote>
<p>set idx [connect <hostname> <port>]</p>
</blockquote>
<p>$idx now contains a new DCC entry for the outgoing connection.</p>
<p>All connections use non-blocking (commonly called
"asynchronous", which is a misnomer) I/O. Without going
into a big song and dance about asynchronous I/O, what this means
to you is:</p>
<ul>
<li>
<p>assume the connection succeeded immediately</p>
</li>
<li>
<p>if the connection failed, an EOF will arrive for that idx</p>
</li>
</ul>
<p>The only time a 'connect' will return an error is if you
give it a hostname that can't be resolved (this is considered a
"DNS error"). Otherwise, it will appear to have succeeded.
If the connection failed, you will immediately get an EOF.</p>
<p>Right after doing a 'connect' call, you should set up a
'control' for the new idx (see the section above). From then
on, the connection will act just like a normal DCC connection that
has been put under the control of a script. If you ever return
"1" from the control proc (indicating that you want control
to return to Eggdrop), the bot will just close the connection and
dispose of it. Other commands that work on normal DCC connections,
like 'killdcc' and 'putdcc', will work on this idx,
too. The 'killdcc' command will fail with "invalid
idx" if you attempt to use it on a closed socket.</p>
<p>To create a listen port, use:</p>
<blockquote>
<p>listen <port> script <proc></p>
</blockquote>
<p>Procs should be declared as:</p>
<blockquote>
<p>procname <newidx></p>
</blockquote>
<p>For example:</p>
<pre>
listen 6687 script listen:grab
proc listen:grab {newidx} {
control $newidx listen:control
}
</pre>
<p>When a new connection arrives in port 6687, Eggdrop will create a
new idx for the connection. That idx is sent to 'listen:grab'.
The proc immediately puts this idx under control. Once
'listen:grab' has been called, the idx behaves exactly like
an outgoing connection would.</p>
<p>The best way to learn how to use these commands is to find a
script that uses them and follow it carefully. However, hopefully
this has given you a good start.</p>
</blockquote>
<p><a name="matchchars"></a>14. <strong>Match characters</strong></p>
<blockquote>
<p>Many of the bindings allow match characters in the arguments. Here
are the four special characters:</p>
<table>
<tr valign="top">
<td>
<p><strong>?</strong></p>
</td>
<td>
<p>matches any single character</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>*</strong></p>
</td>
<td>
<p>matches 0 or more characters of any type</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>%</strong></p>
</td>
<td>
<p>matches 0 or more non-space characters (can be used to match
a single word)</p>
</td>
</tr>
<tr valign="top">
<td>
<p><strong>~</strong></p>
</td>
<td>
<p>matches 1 or more space characters (can be used for whitespace
between words)</p>
</td>
</tr>
</table>
</blockquote>
<hr>
<p><em>Copyright © 1997 Robey Pointer<br>
Copyright © 1999 - 2011 Eggheads Development Team
<a href="http://www.eggheads.org/"> Eggheads Development Team</a></em></p>
</body>
</html>
|