/usr/share/doc/xnee/xnee.html is in xnee-doc 3.19-2.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html401/loose.dtd">
<html>
<!-- Created on January 2, 2018 by texi2html 1.82
texi2html was written by:
Lionel Cons <Lionel.Cons@cern.ch> (original author)
Karl Berry <karl@freefriends.org>
Olaf Bachmann <obachman@mathematik.uni-kl.de>
and many others.
Maintained by: Many creative people.
Send bugs and suggestions to <texi2html-bug@nongnu.org>
-->
<head>
<title>Xnee Manual</title>
<meta name="description" content="Xnee Manual">
<meta name="keywords" content="Xnee Manual">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2html 1.82">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
pre.display {font-family: serif}
pre.format {font-family: serif}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: serif; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: serif; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.roman {font-family:serif; font-weight:normal;}
span.sansserif {font-family:sans-serif; font-weight:normal;}
ul.toc {list-style: none}
-->
</style>
</head>
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Top"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h1 class="settitle">Xnee Manual</h1>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#Summary">1. Summary</a></td><td> </td><td align="left" valign="top"></td></tr>
<tr><td align="left" valign="top"><a href="#Getting-started">2. Getting started</a></td><td> </td><td align="left" valign="top"></td></tr>
<tr><td align="left" valign="top"><a href="#Functional-overview">3. Functional overview</a></td><td> </td><td align="left" valign="top"></td></tr>
<tr><td align="left" valign="top"><a href="#Installation">4. Installation</a></td><td> </td><td align="left" valign="top"></td></tr>
<tr><td align="left" valign="top"><a href="#Examples">5. Examples</a></td><td> </td><td align="left" valign="top"> examples
</td></tr>
<tr><td align="left" valign="top"><a href="#File-format">7. File types and format</a></td><td> </td><td align="left" valign="top"> File format
</td></tr>
<tr><td align="left" valign="top"><a href="#Programs">6. Xnee Programs</a></td><td> </td><td align="left" valign="top"> Programs
</td></tr>
<tr><td align="left" valign="top"><a href="#Internals">8. Xnee Internals</a></td><td> </td><td align="left" valign="top"> Internals
</td></tr>
<tr><td align="left" valign="top"><a href="#Requirements">9. Xnee Requirements</a></td><td> </td><td align="left" valign="top"> Requirements
</td></tr>
<tr><td align="left" valign="top"><a href="#FAQ">10. FAQ</a></td><td> </td><td align="left" valign="top"></td></tr>
<tr><td align="left" valign="top"><a href="#Copying-This-Manual">A. Copying This Manual</a></td><td> </td><td align="left" valign="top"></td></tr>
<tr><td align="left" valign="top"><a href="#Index">B. Index</a></td><td> </td><td align="left" valign="top"></td></tr>
</table>
<hr size="1">
<a name="Summary"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Top" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Summary-1" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[ << ]</td>
<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Getting-started" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Summary-2"></a>
<h1 class="chapter">1. Summary</h1>
<hr size="6">
<a name="Summary-1"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Summary" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Xnee-features" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Summary" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Summary" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Getting-started" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">1.1 Summary</h2>
<p> Xnee is a suite of programs that can record, replay and
distribute user actions under the X11 environment.
Think of it as a robot that can imitate the job you just
did.
</p>
<p>Xnee consists of one library and two applications
</p>
<p> <b>cnee</b> - command line program
</p>
<p> <b>gnee</b> - graphical user interface program
</p>
<p> <b>pnee</b> - a Gnome Panel Applet
</p>
<p> <b>libxnee</b> - library used by xnee and gnee
</p>
<hr size="6">
<a name="Xnee-features"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Summary-1" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Background" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Summary" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Summary" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Getting-started" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">1.2 Xnee features</h2>
<a name="index-features"></a>
<p>Xnee can be used for multiple purposes, although it was initially designed as a test tool. The most used features are the foloowing:
</p>
<p><b>Test tool</b> -
Instead of performing test cases for a GUI (or CLI program)
over and over again, the test cases can be automated. Simply record
a user session and replay it later.
</p>
<p><b>Performance test tool</b> -
If you want to simulate lots of simultaneous users in a network (or
a local machine) you can use Xnee. Simply record a user
session and start multiple instances of Xnee.
</p>
<p><b>Demonstration tool</b> -
You can use Xnee to demonstrate the features of your program. Simply
record a user session and replay it later.
</p>
<p><b>Distribution tool</b> -
If you want to send over your mouse/keyboard actions to another display
you can use the built-in distribution mechanism in Xnee.
</p>
<p><b>Macro recorder/replayer</b> -
By binding a key and modifier combination (e.g using xrebind)
to replay a recorded session you will have a Window Manager and
application independent macro.
</p>
<p><b>File retyper</b> -
Xnee can retype the contents of a file. This can be useful
during tests or if you want xnee to answer some command
session without having to record the session.
</p>
<p><b>X11 protocol sniffer</b> -
Xnee can be used as a sniffer for the X11 protocol.
</p>
<hr size="6">
<a name="Background"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Xnee-features" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Getting-started" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Summary" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Summary" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Getting-started" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">1.3 Background</h2>
<a name="index-background"></a>
<p>In order to verify that a program does the job it’s supposed to do,
certain tests have to be made.
These tests are, IMHO, perhaps the most boring things a programmer
can do. Xnee is designed to reduce the programmer from this burden.
<br>
</p>
<p>Xnee started out as a commad line program. During the development
phase the main functionality was broken out to a library, called
libxnee. The command line program was renamed cnee. The thought behind
making the library was to enable the writing of other clients than
just the command line. Today there is a GUI program, gnee, and a Gnome
panel applet, pnee, that uses the library.
<br>
</p>
<p>By using xnee your testcase(s) can be recorded and later on replayed.
Xnee comes with other features For more information about these, read the
Introduction.
</p>
<p>This manual mainly focuses on the command line program, cnee. There
are however a seperate chapters for the other programs.
</p>
<hr size="6">
<a name="Getting-started"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Background" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Getting-started-2" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Summary" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Getting-started-1"></a>
<h1 class="chapter">2. Getting started</h1>
<hr size="6">
<a name="Getting-started-2"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Getting-started" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Simple-replay" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Getting-started" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Getting-started" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">2.1 Getting started</h2>
<a name="index-Getting-started"></a>
<p>To get the first feel of Xnee some simple examples are presented.
</p>
<hr size="6">
<a name="Simple-replay"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Getting-started-2" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Simple-recording-of-Key-presses" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Getting-started" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Getting-started-2" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">2.1.1 Simple replay</h3>
<p>Start a terminal emulator (e.g xterm) and then start Xnee,
</p><table><tr><td> </td><td><pre class="example"> <code>cnee --replay --file example1.xnr &</code>
</pre></td></tr></table>
<p>....dont forget ’&’.
The file example1.xnr contains keyboard events recorded during
development of this manual. When replayed you’ll see what was typed and of
course more important you’ll get i first glimpse of Xnee and its capabilities.
For information on where to find the example files, see below.
</p>
<hr size="6">
<a name="Simple-recording-of-Key-presses"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Simple-replay" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Simple-replaying-of-your-recorded-file" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Getting-started" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Getting-started-2" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">2.1.2 Simple recording of Key presses</h3>
<p>We move on to a (very) simple recording session.
Start a terminal emulator (e.g xterm) and your favorite editor.
Move the pointer to one of the terminal windows and start Xnee.
</p><table><tr><td> </td><td><pre class="example"> <code>cnee --record -o example2.xnr --device-event-range 2-3 \</code>
<code>--time 5 --events-to-record 20</code>
</pre></td></tr></table>
<p>Move the pointer to the editor and get focus (e.g click the
window frame). After 5 seconds you can type whatever you want to record
(20 press- and relase events of the keyboard are recorded). We are done
and you have recorded your first session! Leave the desktop as it
is and go forward to the next example.
</p>
<hr size="6">
<a name="Simple-replaying-of-your-recorded-file"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Simple-recording-of-Key-presses" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Simple-recording-of-mouse-motions" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Getting-started" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Getting-started-2" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">2.1.3 Simple replaying of your recorded file</h3>
<p>Start one terminal emulator (e.g xterm).
Let Xnee repeat the stuff you did in the example above.
Undo all changes in the editor that was made in the previous example.
Move the pointer to one of the terminal windows and start Xnee.
</p><table><tr><td> </td><td><pre class="example"> <code>cnee --replay -f example2.xnr --time 5</code>
</pre></td></tr></table>
<p>Move the pointer to the editor and get focus (e.g click the
window frame). After 5 seconds you will see your typings in the example
above being repeated.
</p>
<hr size="6">
<a name="Simple-recording-of-mouse-motions"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Simple-replaying-of-your-recorded-file" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Simple-replaying-of-your-recorded-file-1" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Getting-started" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Getting-started-2" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">2.1.4 Simple recording of mouse motions</h3>
<p>We move on to another simple recording session.
Start a terminal emulator (e.g xterm).
Move the pointer to the terminal window and start Xnee.
</p><table><tr><td> </td><td><pre class="example"> <code>cnee --record -o example3.xnr --device-event-range 5-6 \</code>
<code>--time 5 --events-to-record 20</code>
</pre></td></tr></table>
<p>After 5 seconds you can move the pointer around (20 motion events are recorded).
</p>
<hr size="6">
<a name="Simple-replaying-of-your-recorded-file-1"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Simple-recording-of-mouse-motions" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Simple-retyping-of-a-text-file" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Getting-started" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Getting-started-2" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">2.1.5 Simple replaying of your recorded file</h3>
<p>Let Xnee repeat the stuff you did in the example above..
Move the pointer to the terminal window and start Xnee.
</p><table><tr><td> </td><td><pre class="example"> <code>cnee --replay -f example3.xnr --time 5</code>
</pre></td></tr></table>
<p>After 5 seconds you will see your mouse motions in the example above being
repplayed.
</p>
<hr size="6">
<a name="Simple-retyping-of-a-text-file"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Simple-replaying-of-your-recorded-file-1" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Example-Xnee-Session-files" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Getting-started" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Getting-started-2" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">2.1.6 Simple retyping of a text file</h3>
<p>Let Xnee retype (type again) the text in a text file.
Move the pointer to the terminal window and create a text file containing
the command <code>ls -l</code>.
</p><table><tr><td> </td><td><pre class="example"> <code>echo "ls -l" > ./mytext.txt</code>
</pre></td></tr></table>
<p>And after that you start Xnee.
</p><table><tr><td> </td><td><pre class="example"> <code>cnee --retype-file ./mytext.txt --time 5</code>
</pre></td></tr></table>
<p>After 5 seconds you will see Xnee type <code>ls -l</code>, which probably will
list the files in the current directory.
</p>
<hr size="6">
<a name="Example-Xnee-Session-files"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Simple-retyping-of-a-text-file" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Getting-started" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Getting-started-2" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">2.1.7 Example Xnee Session files</h3>
<a name="index-Example-Xnee-Session-files"></a>
<p>The example file above (example1.xnr) is a session file that has been
delivered with the sources (allthough not installed), rpm and with the
Xnee Documentation Package. The file(s) can be found:
</p><table>
<tr><td width="30%"></td><td width="30%"><b>Distribution</b></td><td width="30%"><b>Location</b></td></tr>
<tr><td width="30%"></td><td width="30%">RPM</td><td width="30%">/usr/lib/xnee/session</td></tr>
<tr><td width="30%"></td><td width="30%">Source</td><td width="30%">./sessions/</td></tr>
<tr><td width="30%"></td><td width="30%">Document Package</td><td width="30%">./sessions/</td></tr>
</table>
<hr size="6">
<a name="Functional-overview"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Example-Xnee-Session-files" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Functional-overview-2" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Getting-started" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Functional-overview-1"></a>
<h1 class="chapter">3. Functional overview</h1>
<hr size="6">
<a name="Functional-overview-2"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Functional-overview" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Modes" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">3.1 Functional overview</h2>
<a name="index-Functional-overview"></a>
<p>The Xnee applications (gnee and xnee) receives X11 protocol data (e.g. events)
from an X server (using libxnee) and print them to a file, called Xnee
Session File. Theses events are later read from the session file and replayed.
Gnee and xnee can read its settings from a file, called Xnee Project File,
or from command line (cnee) or via the GUI (gnee).
</p>
<br>
<p>Events directly generated by the user (e.g KeyPress) can be replayed
or faked. Requests, replies, errors and events not directly generated by the
user (e.g MapNotify) can be recorded as well. By using these data
Xnee can replay with synchronisation.
</p>
<p>This picture gives an overview of Xnee and the files used.
<br>
<img src="xngener.png" alt="xngener">
In this section you will be given information about key concepts in X11 and Xnee. It is
vital that you read through this chapter.
</p>
<hr size="6">
<a name="Modes"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Functional-overview-2" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Record" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">3.2 Modes</h2>
<a name="index-modes"></a>
<p>Xnee has four modes:
</p><ul>
<li> record
</li><li> replay
</li><li> retype
</li><li> distribute
</li></ul>
<p>The distribution mechanism can be used together with the other three.
</p>
<hr size="6">
<a name="Record"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Modes" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Replay" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Modes" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">3.2.1 Record</h3>
<a name="index-recording"></a>
<p>When record mode is used Xnee receives a copy of the data sent to and from the
X server. The copy is printed to a file. Xnee can record the whole X11
protocol, not just mouse and keyboard events.
</p>
<p>This picture gives an overview of Xnee and the files used when recording.
<br>
<img src="xnrec.png" alt="xnrec">
</p>
<hr size="6">
<a name="Replay"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Record" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Retype" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Modes" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">3.2.2 Replay</h3>
<a name="index-replaying"></a>
<p>When replay mode is used Xnee reads data from a file or stdin. These data is
either sent to the server (if it is a keyboard or a mouse event) or used to
synchronise with (if any of the other data).
</p>
<p>This picture gives an overview of Xnee and the files used when replaying.
<br>
<img src="xnrep.png" alt="xnrep">
</p>
<hr size="6">
<a name="Retype"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Replay" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Distribution" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Modes" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">3.2.3 Retype</h3>
<a name="index-retype"></a>
<p>Xnee can retype the contents of a text file. This is useful when combining
replaying of different recorded session. You can change the text written in
for example an editor (e.g emacs) without having to re-record the complete
sessions.
</p>
<hr size="6">
<a name="Distribution"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Retype" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Ranges" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Modes" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">3.2.4 Distribution</h3>
<a name="index-distributing"></a>
<p>Xnee can fake mouse and keyboard events on multiple displays. This
distribution mechanism can be used when recording, replaying or retyping.
</p>
<hr size="6">
<a name="Ranges"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Distribution" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#First-and-last-motion-event" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">3.3 Ranges</h2>
<a name="index-ranges"></a>
<p>What data to record is specified using ranges. Ranges has a start value and
a stop value. The following data can be recorded:
</p>
<table>
<tr><td width="10%"></td><td width="45%"><b>Xnee name</b></td><td width="45%"><b>X Protocol Name</b></td></tr>
<tr><td width="10%"></td><td width="45%">core-requests</td><td width="45%">Request</td></tr>
<tr><td width="10%"></td><td width="45%">device-event</td><td width="45%">Event</td></tr>
<tr><td width="10%"></td><td width="45%">delivered-event</td><td width="45%">Event</td></tr>
<tr><td width="10%"></td><td width="45%">error</td><td width="45%">Error</td></tr>
<tr><td width="10%"></td><td width="45%">reply</td><td width="45%">Reply</td></tr>
<tr><td width="10%"></td><td width="45%">ext-requests.ext-major</td><td width="45%">Extension Request</td></tr>
<tr><td width="10%"></td><td width="45%">ext-requests.ext-minor</td><td width="45%">Extension Request</td></tr>
<tr><td width="10%"></td><td width="45%">ext-replies.ext-major</td><td width="45%">Extension Reply</td></tr>
<tr><td width="10%"></td><td width="45%">ext-replies.ext-minor</td><td width="45%">Extension Reply</td></tr>
</table>
<p>When specifying the ranges when using xnee you can either type the integer value
of the data or the name of the data. To find out what number belongs to what
data name, you can use the <code>--print-data-name</code> option. For an explanation
of the X protocol data, please read the "X Record Extension Library" or the
"Record Extension Protocol Specification".
</p>
<hr size="6">
<a name="First-and-last-motion-event"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Ranges" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Delay" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">3.4 First and last motion event</h2>
<p>Xnee has the ability to skip recording of succesive motion events with no
other data in between. This option is intended to reduce the number of data
recorded by leaving out unnecessary data. This feature can be invoked with
the <code>--first-last</code> flag.
</p>
<hr size="6">
<a name="Delay"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#First-and-last-motion-event" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Verbose" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">3.5 Delay</h2>
<p>Sometimes when Xnee starts recording data, the keyrelease (caused by pressing and
releasing RETURN to execute the Xnee command line) is recorded. This single
keyrelease (with no corresponding keypress) might confuse the X server.
With the <code>--time <secs></code> option Xnee can be paused for a number of seconds
before recording/replaying/retyping starts.
</p>
<hr size="6">
<a name="Verbose"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Delay" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Human-printouts" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">3.6 Verbose</h2>
<p>When enabling verbose mode (<code>--verbose</code>) Xnee prints a lot of information
about it’s state. This option is only intended for runtime debugging.
</p>
<hr size="6">
<a name="Human-printouts"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Verbose" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Invoking-Xnee" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">3.7 Human printouts</h2>
<p>Sometimes it’s hard to decide what data to use when synchronising. To do this
you have to analyse what data is sent from the server when recording. Instead of
reading the data number, s tring representation of the data is printed out.
To enable this option, use the <code>--human-printouts</code>.
</p>
<hr size="6">
<a name="Invoking-Xnee"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Human-printouts" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Command-line-syntax" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">3.8 Invoking Xnee</h2>
<hr size="6">
<a name="Command-line-syntax"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Invoking-Xnee" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Project-file" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Invoking-Xnee" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">3.8.1 Command line syntax</h3>
<a name="index-command-line-syntax"></a>
<p>To get information about how to use Xnee’s command line options please use the man page(s).
</p>
<hr size="6">
<a name="Project-file"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Command-line-syntax" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Session-file" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Invoking-Xnee" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">3.8.2 Project file</h3>
<p>To use a Project file use the <code>--project</code> option, e.g
<code>cnee --project xnee/projects/netscape.xns</code>.
</p>
<hr size="6">
<a name="Session-file"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Project-file" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Interupting-Xnee" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Invoking-Xnee" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">3.8.3 Session file</h3>
<p>To use a session file use the <code>--file</code> option, e.g
<code>cnee --file user1_session.xns</code>
</p>
<hr size="6">
<a name="Interupting-Xnee"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Session-file" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#modifier-and-key" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">3.9 Interupting Xnee</h2>
<a name="index-Interupting-xnee"></a>
<p>Interupting Xnee when recording or replaying can be done as follows
</p><ul>
<li> user specified modifier and key
</li><li> limit the number of data to record
</li><li> sending a SIGTERM signal (e.g pressing Control-c in a terminal window)
</li></ul>
<p>The prefered way to interrupt xnee is to use the modifier+key.
</p>
<hr size="6">
<a name="modifier-and-key"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Interupting-Xnee" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#limit-the-number-of-data-to-record" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Interupting-Xnee" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">3.9.1 modifier and key</h3>
<a name="index-modifier"></a>
<a name="index-key"></a>
<p>It is possible to specify a modifier (e.g Control button) and a key (e.g ’a’)
that will stop the Xnee session. When using this option make sure that the
modifier/key is not used in any way by the applications you are recording.
You can specify a key+modifier to stop, pause and resume xnee. You can also
insert a mark in the recorded session file.
</p>
<hr size="6">
<a name="limit-the-number-of-data-to-record"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#modifier-and-key" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#sending-a-SIGTERM-signal" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Interupting-Xnee" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">3.9.2 limit the number of data to record</h3>
<p>By specifying the number of data to record (<code>--loops</code>) xnee stops when this number
of data is received from the server. When replaying the same amount of data
is replayed.
</p>
<hr size="6">
<a name="sending-a-SIGTERM-signal"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#limit-the-number-of-data-to-record" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Stop-Xnee-with-key-combination" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Interupting-Xnee" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">3.9.3 sending a SIGTERM signal</h3>
<a name="index-SIGTERM"></a>
<p>The easiest way to send a signal to a process is by launching Xnee
from a terminal window (e.g xterm) and then press Control-c which will
send the SIGTERM signal to Xnee. When replaying it can sometimes be
hard to move the pointer into the terminal window (e.g if a lot of
motion events were recorded that will let you compete with Xnee on
where the mouse pointer shall be located. Beleive me, you’ll end up
lossing that battle).
</p>
<p>When using Control-c to stop Xnee you must be aware of that the pressing of the Control key gets recorded. When replaying a recorded session ending with pressing of Control your apps may think you are pressing the Control key. A simple solution for this is to press and release the Control.
</p>
<hr size="6">
<a name="Stop-Xnee-with-key-combination"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#sending-a-SIGTERM-signal" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Pause-Xnee-with-key-combination" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Interupting-Xnee" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">3.9.4 Stop Xnee with key combination</h3>
<a name="index-Stop-Xnee-with-key-combination"></a>
<p>Xnee stops its current action when the user presses the key
combination as specified during setup. Xnee will be shut gracefully.
</p>
<hr size="6">
<a name="Pause-Xnee-with-key-combination"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Stop-Xnee-with-key-combination" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Pause-Xnee-with-key-combination-1" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Interupting-Xnee" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">3.9.5 Pause Xnee with key combination</h3>
<a name="index-Pause-Xnee-with-key-combination"></a>
<p>Xnee pause its current action when the user presses the key
combination as specified during setup. Xnee will be in paused mode until
the user stops or resumes Xnee.
</p>
<hr size="6">
<a name="Pause-Xnee-with-key-combination-1"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Pause-Xnee-with-key-combination" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Insert-marks-Xnee-with-key-combination" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Interupting-Xnee" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">3.9.6 Pause Xnee with key combination</h3>
<a name="index-Pause-Xnee-with-key-combination-1"></a>
<p>Xnee resumes its current paused action when the user presses the key
combination as specified during setup. Xnee will continue where it was
paused.
</p>
<hr size="6">
<a name="Insert-marks-Xnee-with-key-combination"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Pause-Xnee-with-key-combination-1" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Limit-number-of-data-to-record" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Interupting-Xnee" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">3.9.7 Insert marks Xnee with key combination</h3>
<a name="index-Insert-marks-Xnee-with-key-combination"></a>
<p>When the user presses the key combination as specified during setup
Xnee will print a mark in the session file containing a time stamp. This
feature is intended be used when you want to mark an interresting time/event
during recording. After recording has finished you can add Xnee scripting
calls to Xnee which will be interpreted and executed as if they were recorded.
</p>
<hr size="6">
<a name="Limit-number-of-data-to-record"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Insert-marks-Xnee-with-key-combination" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Limit-the-events-to-record" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Interupting-Xnee" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">3.9.8 Limit number of data to record</h3>
<p>There a a few ways to limit the number of data Xnee records.
</p><ul>
<li> limit the events to recored
</li><li> limit the data to recored
</li><li> limit the time to recored
</li><li> send a signal to xnee (SIGTERM)
</li><li> use a selfmade record callback function
</li></ul>
<hr size="6">
<a name="Limit-the-events-to-record"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Limit-number-of-data-to-record" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Limit-the-data-to-record" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Interupting-Xnee" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">3.9.9 Limit the events to record</h3>
<a name="index-limit-the-events"></a>
<p>When having received the specified amount of events from the server, Xnee
stops the recording. For more information on how to use this option, read
the man page for cnee or the user manual for gnee.
</p>
<hr size="6">
<a name="Limit-the-data-to-record"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Limit-the-events-to-record" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Limit-the-time-to-record" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Interupting-Xnee" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">3.9.10 Limit the data to record</h3>
<a name="index-limit-the-data"></a>
<p>When having received the specified amount of data from the server, Xnee
stops the recording. For more information on how to use this option, read
the man page for cnee or the user manual for gnee.
</p>
<hr size="6">
<a name="Limit-the-time-to-record"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Limit-the-data-to-record" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Send-SIGTERM-to-Xnee" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Interupting-Xnee" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">3.9.11 Limit the time to record</h3>
<a name="index-limit-the-events-1"></a>
<p>When having recorded for the specified amount of time from the server, Xnee
stops the recording. For more information on how to use this option, read
the man page for cnee or the user manual for gnee.
</p>
<hr size="6">
<a name="Send-SIGTERM-to-Xnee"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Limit-the-time-to-record" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Xnee-plugins" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Interupting-Xnee" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">3.9.12 Send SIGTERM to Xnee</h3>
<a name="index-SIGTERM-1"></a>
<p>The easiest way to send a signal to a process is by launching Xnee from a
terminal window (e.g xterm). By pressing Control-c xterm sends the
SIGTERM signal to Xnee. When replaying it can sometimes be hard to
move the pointer into the terminal window (e.g if a lot of motion
events were recorded that will let you compete with Xnee on where
the mouse pointer shall be located. Beleive me, you’ll end up lossing
that battle).
</p>
<hr size="6">
<a name="Xnee-plugins"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Send-SIGTERM-to-Xnee" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">3.10 Xnee plugins</h2>
<a name="index-plugins"></a>
<p>Xnee supports plugins since version 1.07. For information about how to write
plugins, download the source code and look at the plugin example which is
delivered with Xnee.
</p>
<hr size="6">
<a name="Installation"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Xnee-plugins" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Installation-from-source-with-the-configure-script" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Functional-overview" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Examples" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Installation-1"></a>
<h1 class="chapter">4. Installation</h1>
<hr size="6">
<a name="Installation-from-source-with-the-configure-script"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Installation" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Installation-from-source-with-default-Makefile" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Installation" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Examples" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">4.1 Installation from source with the configure script</h2>
<p>To build and install Xnee do the following:
Download the following source files into a directory (version numbers given here are just examples)
</p><ul>
<li> xnee-3.02.tar.gz
</li></ul>
<br>
<p>Unzip the source file
</p><table><tr><td> </td><td><pre class="example"><code>gunzip xnee-3.02.tar.gz</code>
</pre></td></tr></table>
<br>
<p>Untar the source file
</p><table><tr><td> </td><td><pre class="example"><code>tar xvf xnee-3.02.tar</code>
</pre></td></tr></table>
<br>
<p>Enter the Xnee directory
</p><table><tr><td> </td><td><pre class="example"><code>cd xnee-3.02</code>
</pre></td></tr></table>
<br>
<p>Generate the makefiles
</p><table><tr><td> </td><td><pre class="example"><code>./configure</code>
</pre></td></tr></table>
<br>
<p>or if you want to specify which directory to install xnee to
</p><table><tr><td> </td><td><pre class="example"><code>./configure --prefix=<PATH TO INSTALLATION DIR></code>
</pre></td></tr></table>
<br>
<p>Build Xnee
</p><table><tr><td> </td><td><pre class="example"><code>make clean all</code>
</pre></td></tr></table>
<br>
<p>Install (as root) if you want libxnee to be installed. If not, skip the following command. Installation of libxnee is not needed to build cnee and gnee.
</p><table><tr><td> </td><td><pre class="example"><code>make install</code>
</pre></td></tr></table>
<hr size="6">
<a name="Installation-from-source-with-default-Makefile"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Installation-from-source-with-the-configure-script" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Installation-from-CVS" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Installation" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Examples" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">4.2 Installation from source with default Makefile</h2>
<p>To unpack, build and install Xnee from the sourcefiles do the following:
<br>
Download the source files into a directory
</p>
<p>Unzip the source file
</p><table><tr><td> </td><td><pre class="example"><code>gunzip xnee-3.02.tar.gz</code>
</pre></td></tr></table>
<p>Untar the source file
</p><table><tr><td> </td><td><pre class="example"><code>tar xvf xnee-3.02.tar</code>
</pre></td></tr></table>
<p>Enter the Xnee directory
</p><table><tr><td> </td><td><pre class="example"><code>cd xnee-3.02</code>
</pre></td></tr></table>
<p>Build Xnee
</p><table><tr><td> </td><td><pre class="example"><code>make -f Makefile.xnee clean all</code>
</pre></td></tr></table>
<p>Copy the Xnee binary (xnee/src/xnee) to a directory
</p><table><tr><td> </td><td><pre class="example"><code>cp xnee/src/xnee /usr/local/bin</code>
</pre></td></tr></table>
<hr size="6">
<a name="Installation-from-CVS"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Installation-from-source-with-default-Makefile" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Examples" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Installation" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Installation" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Examples" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">4.3 Installation from CVS</h2>
<br>
<p>Download the xnee source code from the CVS repository at
<a href="http://savannah.gnu.org">http://savannah.gnu.org</a>. Instructions on how to do
this can be found there as well.
</p>
<br>
<p>Build Xnee
</p><table><tr><td> </td><td><pre class="example"><code>cd xnee</code>
<code>make -f Makefile.cvs</code>
<code>./configure --enable-doc</code>
<code>make</code>
<code>make install</code> (optional)
</pre></td></tr></table>
<p>Build Xnee Documentation
</p><table><tr><td> </td><td><pre class="example"><code>cd doc</code>
<code>make manual</code>
<code>make install</code> (as root)
<code>cd ..</code>
</pre></td></tr></table>
<hr size="6">
<a name="Examples"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Installation-from-CVS" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Recorder" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Installation" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Examples-1"></a>
<h1 class="chapter">5. Examples</h1>
<hr size="6">
<a name="Recorder"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Examples" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Record-mouse-motions" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Examples" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">5.1 Recorder</h2>
<hr size="6">
<a name="Record-mouse-motions"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Recorder" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Record-keyboard" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Recorder" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">5.1.1 Record mouse motions</h3>
<a name="index-Record-mouse-motions"></a>
<p>Record mouse motions only and save the session to mouse-rec.xnl.
</p><table><tr><td> </td><td><pre class="example"> <code>cnee --record --mouse --out-file mouse-rec.xnl</code>
</pre></td></tr></table>
<p>After having typed this you can move your mouse round for a while. After Xnee
has exited you will be able to replay your motions. Xnee will stop
after having record 100 events (this is the default behaviour).
</p>
<hr size="6">
<a name="Record-keyboard"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Record-mouse-motions" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Record-keyboard-and-mouse" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Recorder" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">5.1.2 Record keyboard</h3>
<a name="index-Record-keyboard"></a>
<p>Record keyboard events only and save log to kbd-rec.xnl.
</p><table><tr><td> </td><td><pre class="example"> <code>cnee --record --keyboard --out-file kbd-rec.xnl</code>
</pre></td></tr></table>
<p>After having typed this Xnee records all your keyboard actions. After Xnee
has exited you will be able to replay your keyboard actions. Xnee will stop
after having record 100 events (this is the default behaviour).
</p>
<hr size="6">
<a name="Record-keyboard-and-mouse"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Record-keyboard" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Record-a-gnumeric-session" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Recorder" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">5.1.3 Record keyboard and mouse</h3>
<a name="index-Record-keyboard-and-mouse"></a>
<p>Record keyboard and mouse and save log to km-rec.xnl.
</p><table><tr><td> </td><td><pre class="example"> <code>cnee --record --keyboard --mouse --out-file kbd-rec.xnl</code>
</pre></td></tr></table>
<p>After having typed this Xnee records all your keyboard and mouse actions.
So now move your pointer and write some stuff with your keyboard. After Xnee
has exited you will be able to replay your keyboard and mouse actions. Xnee
will stop after having record 100 events (this is the default behaviour).
</p>
<hr size="6">
<a name="Record-a-gnumeric-session"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Record-keyboard-and-mouse" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Record-a-gnumeric-session-with-synchronisation-data" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Recorder" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">5.1.4 Record a gnumeric session</h3>
<a name="index-Record-a-gnumeric-session"></a>
<p>Record a gnumeric session. Record 400 events. Save output in file gnumeric.xnl
Start a terminal emulator (e.g xterm)
</p><table><tr><td> </td><td><pre class="example"><code>xterm&</code>
</pre></td></tr></table>
<p>Start Xnee
</p><table><tr><td> </td><td><pre class="example"> <code>cnee --record --keyboard --mouse --events-to-record 400 \</code>
<code> --out-file gnumeric.xnl&</code>
</pre></td></tr></table>
<p>Start gnumeric
</p><table><tr><td> </td><td><pre class="example"><code>gnumeric&</code>
</pre></td></tr></table>
<p>Start using gnumeric. Browse the menus above, reset the fonts etc.
</p>
<hr size="6">
<a name="Record-a-gnumeric-session-with-synchronisation-data"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Record-a-gnumeric-session" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Replayer" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Recorder" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">5.1.5 Record a gnumeric session with synchronisation data</h3>
<a name="index-Record-a-gnumeric-session-with-synchronisation-data"></a>
<p>Record a gnumeric session. Record 400 events. Save output in file gnumeric2.xnl
</p>
<br>
<p>Start a terminal emulator (e.g xterm)
<code>xterm&</code>
</p>
<p>Start Xnee
</p><table><tr><td> </td><td><pre class="example"> <code>cnee --record --keyboard --mouse --events-to-record 400 \</code>
<code> --out-file gnumeric2.xnl\</code>
<code>--delivered-event-range Expose,MapRequest,LeaveNotify,EnterNotify &</code>
</pre></td></tr></table>
<br>
<p>Start gnumeric
<code>gnumeric&</code>
Start using gnumeric. Browse the menus above, reset the fonts etc.
</p>
<hr size="6">
<a name="Replayer"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Record-a-gnumeric-session-with-synchronisation-data" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Replay-mouse-motions" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Examples" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">5.2 Replayer</h2>
<hr size="6">
<a name="Replay-mouse-motions"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Replayer" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Replay-mouse-motions-using-with-half-speed" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Replayer" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">5.2.1 Replay mouse motions</h3>
<a name="index-replay-mouse-motions"></a>
<p>Replay mouse motions as found in the file mouse-rec.xnl.
</p><table><tr><td> </td><td><pre class="example"> <code>cnee --replay --file mouse-rec.xnl</code>
</pre></td></tr></table>
<p>Xnee will now imitate exactly what you did when you recorded this file.
</p>
<hr size="6">
<a name="Replay-mouse-motions-using-with-half-speed"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Replay-mouse-motions" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Replay-mouse-motions-using-with-double-speed" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Replayer" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">5.2.2 Replay mouse motions using with half speed</h3>
<a name="index-replay-using-half-speed"></a>
<p>Replay mouse motions as found in the file mouse-rec.xnl but with the
speed set to 50% of the recorded.
</p><table><tr><td> </td><td><pre class="example"> <code>cnee --replay --file mouse-rec.xnl --speed-percent 50</code>
</pre></td></tr></table>
<p>Xnee will now imitate exactly what you did when you recorded this file,
allthough it will be done in 50% of the recorded time.
</p>
<hr size="6">
<a name="Replay-mouse-motions-using-with-double-speed"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Replay-mouse-motions-using-with-half-speed" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Replay-keyboard-actions" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Replayer" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">5.2.3 Replay mouse motions using with double speed</h3>
<a name="index-replay-using-double-speed"></a>
<p>Replay mouse motions as found in the file mouse-rec.xnl but with the
speed set to 200% of the recorded.
</p><table><tr><td> </td><td><pre class="example"> <code>cnee --replay --file mouse-rec.xnl --speed-percent 200</code>
</pre></td></tr></table>
<p>Xnee will now imitate exactly what you did when you recorded this file,
allthough it will be done twice as fast as when recorded.
</p>
<hr size="6">
<a name="Replay-keyboard-actions"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Replay-mouse-motions-using-with-double-speed" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Replay-keyboard-and-mouse" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Replayer" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">5.2.4 Replay keyboard actions</h3>
<a name="index-Replay-keyboard-actions"></a>
<p>Replay keyboard events from file kbd-rec.xnl.
</p><table><tr><td> </td><td><pre class="example"> <code>cnee --replay --file kbd-rec.xnl</code>
</pre></td></tr></table>
<p>After having typed this Xnee replays all your keyboard actions. After Xnee
has exited you will be able to replay your keyboard actions.
</p>
<hr size="6">
<a name="Replay-keyboard-and-mouse"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Replay-keyboard-actions" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Replay-a-gnumeric-session" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Replayer" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">5.2.5 Replay keyboard and mouse</h3>
<a name="index-Replay-keyboard-and-mouse"></a>
<p>Replay keyboard and mouse from the file km-rec.xnl.
</p><table><tr><td> </td><td><pre class="example"> <code>cnee --replay --keyboard --mouse --file kbd-rec.xnl</code>
</pre></td></tr></table>
<p>After having typed this Xnee replays all your keyboard and mouse actions.
Xnee moves your pointer and writes the the same stuff as you did when
recording.
</p>
<hr size="6">
<a name="Replay-a-gnumeric-session"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Replay-keyboard-and-mouse" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Replay-a-gnumeric-session-with-synchronisation-data" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Replayer" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">5.2.6 Replay a gnumeric session</h3>
<a name="index-Replay-a-gnumeric-session"></a>
<p>Replay the gnumeric session above
<br>
Start a terminal emulator (e.g xterm)
<code>xterm&</code>
Start a new fresh gnumeric spreadsheet
<code>gnumeric&</code>
</p>
<p>Start Xnee
</p><table><tr><td> </td><td><pre class="example"> <code>cnee --replay --file gnumeric.xnl</code>
</pre></td></tr></table>
<p>Xnee will now do the same stuff you did when recording. It may happen
that some user actions are replayed to early. This is so because Xnee has
no way of knowing if it is in sync with the recorded session.
</p>
<hr size="6">
<a name="Replay-a-gnumeric-session-with-synchronisation-data"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Replay-a-gnumeric-session" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Replay-a-gnumeric-session-with-synchronisation-data-setting-threshold" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Replayer" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">5.2.7 Replay a gnumeric session with synchronisation data</h3>
<a name="index-Replay-a-gnumeric-session-with-synchronisation-data"></a>
<p>Replay the second gnumeric session above.
<br>
Start a terminal emulator (e.g xterm)
<code>xterm&</code>
Start a new fresh gnumeric spreadsheet
<code>gnumeric&</code>
</p>
<p>Start Xnee
</p><table><tr><td> </td><td><pre class="example"> <code>cnee --replay --file gnumeric2.xnl</code>
</pre></td></tr></table>
<p>Xnee will now do the same stuff you did when recording. It may happen
that the replaying slows down. This is because Xnee is currently out of sync.
When being out of sync Xnee slows down a bit and checks the thresholds if it
is allowed to continue. Xnee will most probably find itself in sync after
a short while. All recorded user actions should have occured the same way
as when recording.
</p>
<hr size="6">
<a name="Replay-a-gnumeric-session-with-synchronisation-data-setting-threshold"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Replay-a-gnumeric-session-with-synchronisation-data" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Retyper" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Replayer" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">5.2.8 Replay a gnumeric session with synchronisation data setting threshold</h3>
<a name="index-Replay-a-gnumeric-session-with-synchronisation-data-setting-threshold"></a>
<p>Replay the second gnumeric session above.
<br>
Start a terminal emulator (e.g xterm)
<code>xterm&</code>
Start a new fresh gnumeric spreadsheet
<code>gnumeric&</code>
</p>
<hr size="6">
<a name="Retyper"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Replay-a-gnumeric-session-with-synchronisation-data-setting-threshold" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Retype-the-help-printout" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Examples" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">5.3 Retyper</h2>
<hr size="6">
<a name="Retype-the-help-printout"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Retyper" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Retype-a-file" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Retyper" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">5.3.1 Retype the help printout</h3>
<a name="index-Retype-the-help-printout"></a>
<p>If you want Xnee to fake a user typing the help printout from xnee
you can use the <code>--type-help</code> option.
<br>
Start a terminal emulator (e.g xterm) and an editor (e.g emacs).
</p><table><tr><td> </td><td><pre class="example"><code>xterm &</code>
</pre></td></tr></table>
<table><tr><td> </td><td><pre class="example"><code>emacs &</code>
</pre></td></tr></table>
<p>Retype the help printout by starting xnee with a 10 seconds delay delay.
</p><table><tr><td> </td><td><pre class="example"><code>cnee --time 10 --type-help</code>
</pre></td></tr></table>
<p>Move your mouse to the editor and make the editor have focus.
Wait a few seconds and xnee will type the help. You will now also have a
copy of help text.
</p>
<hr size="6">
<a name="Retype-a-file"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Retype-the-help-printout" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Distributor" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Retyper" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">5.3.2 Retype a file</h3>
<a name="index-Retype-a-file"></a>
<p>If you want Xnee to fake a user typing the letters as found in a text
file you can use the retype mode. Note that it isn’t possible to retype all
characters yet. This will be implemented as soon as possible. We’ll give
an example on how to use this mode.
<br>
Start a terminal emulator (e.g xterm)
</p><table><tr><td> </td><td><pre class="example"><code>xterm &</code>
</pre></td></tr></table>
<p>Create a text file
</p><table><tr><td> </td><td><pre class="example"><code>echo "Hi Xnee" > testfile.txt</code>
</pre></td></tr></table>
<p>Retype the contents of this file to another file by starting xnee
with a 10 seconds delay delay.
</p><table><tr><td> </td><td><pre class="example"><code>cnee --time 10 --retype-file testfile.txt</code>
</pre></td></tr></table>
<p>Start the fabulous editor <code>cat</code>
</p><table><tr><td> </td><td><pre class="example"><code>cat > copiedfile.txt</code>
</pre></td></tr></table>
<p>Wait a few seconds and xnee will retype the letters in the file
<code>testfile.txt</code>. You will now also have a copy of that file.
The copy is called copiedfile.txt. This is a realy a stupid way
to copy a file but this option opens up a few possibilities.
</p>
<hr size="6">
<a name="Distributor"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Retype-a-file" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Distribute-your-mouse-motions" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Examples" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">5.4 Distributor</h2>
<p>With the distribution mode Xnee can send your device events to
multiple displays.
</p>
<hr size="6">
<a name="Distribute-your-mouse-motions"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Distributor" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Distribute-the-replaying-of-mouse-motions" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Distributor" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">5.4.1 Distribute your mouse motions</h3>
<a name="index-Distribute-your-mouse-motions"></a>
<p>You can distribute your mouse motions to the displays frodo:0.0 and
sam:0.0
<br>
Start a terminal emulator (e.g xterm)
</p><table><tr><td> </td><td><pre class="example"><code>xterm &</code>
</pre></td></tr></table>
<p>Start xnee
</p><table><tr><td> </td><td><pre class="example"><code>cnee --distribute frodo:0,sam:0.0</code>
<code> --record --mouse</code>
</pre></td></tr></table>
<p>If you have setup authority correct on frodo and sam you will
see all you mouse motions being done on those displays as well.
</p>
<hr size="6">
<a name="Distribute-the-replaying-of-mouse-motions"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Distribute-your-mouse-motions" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Distribute-the-retyping-of-a-file" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Distributor" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">5.4.2 Distribute the replaying of mouse motions</h3>
<a name="index-Distribute-the-replaying-of-mouse-motions"></a>
<p>Replay and distribute mouse motions as found in the file
<code>mouse-rec.xnl</code>.
</p><table><tr><td> </td><td><pre class="example"> <code>cnee --replay --file mouse-rec.xnl</code>
<code> --distribute frodo:0,sam:0.0</code>
</pre></td></tr></table>
<p>Xnee will now imitate exactly what you did when you recorded this file on
your host as well on frodo and sam.
</p>
<hr size="6">
<a name="Distribute-the-retyping-of-a-file"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Distribute-the-replaying-of-mouse-motions" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Key" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Distributor" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">5.4.3 Distribute the retyping of a file</h3>
<a name="index-Distribute-the-retyping-of-a-file"></a>
<p>If you want Xnee to to distribute the fakeing of a user typing the
letters as found in a text file you can use the retype mode together
with the distribution mode.
<br>
Start a terminal emulator (e.g xterm) on each of the hosts
</p><table><tr><td> </td><td><pre class="example"><code>xterm &</code>
</pre></td></tr></table>
<p>Create a text file.
</p><table><tr><td> </td><td><pre class="example"><code>echo "Hi again Xnee" > distfile.txt</code>
</pre></td></tr></table>
<p>Retype the contents of this file to another file by starting xnee
with a 10 seconds delay delay.
</p><table><tr><td> </td><td><pre class="example"><code>cnee --time 10 --retype-file distfile.txt</code>
<code> --distribute frodo:0,sam:0.0 </code>
</pre></td></tr></table>
<p>Start the fabulous editor <code>cat</code> on the terminal emulators on each the
terminals.
</p><table><tr><td> </td><td><pre class="example"><code>cat > copiedfile.txt</code>
</pre></td></tr></table>
<br>
<p>If you have setup authority correct on frodo and sam you will, after
a few seconds, see xnee retype the letters in the file
<code>distfile.txt</code>. You will now also have three copies of that file.
On copy on each host. The copy is called copiedfile.txt. This might
seem like a stupid way to copy a file to three locations but this
is just an example.
</p>
<hr size="6">
<a name="Key"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Distribute-the-retyping-of-a-file" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Stop-Xnee-with-key" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Examples" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">5.5 Key</h2>
<hr size="6">
<a name="Stop-Xnee-with-key"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Key" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Pausing-and-resuming-Xnee-with-key" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Key" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">5.5.1 Stop Xnee with key</h3>
<a name="index-Stop-Xnee-with-key"></a>
<p>You can stop xnee by specifying a key. Make
sure that this key isn’t grabbed by another X client (e.g by the
Window Manager). Let’s say that you want Xnee to stop recording if you press
Control and h.
</p><table><tr><td> </td><td><pre class="example"> <code>cnee --record --mouse --events-to-record -1 --stop-key h</code>
</pre></td></tr></table>
<p>This will make xnee record mouse events until you press h.
All printouts are done to stdout so you can see that Xnee stops when you
press the key.
<br>
Move your mouse for a while and you’ll see xnee print out lots of lines.
<br>
Press h.
<br>
Xnee will now have stopped recording.
</p>
<hr size="6">
<a name="Pausing-and-resuming-Xnee-with-key"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Stop-Xnee-with-key" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Using-macro" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Key" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">5.5.2 Pausing and resuming Xnee with key</h3>
<a name="index-Pausing-and-resuming-Xnee-with-key"></a>
<p>You can pause and resum xnee by specifying a key.
Make sure that this key isn’t grabbed by another X client (e.g by
the Window Manager). Let’s say that you want Xnee to pause recording if you
press p and to resume when pressing Comntrol and r.
</p><table><tr><td> </td><td><pre class="example"> <code>cnee --record --mouse --events-to-record -1 --pause-key p \</code>
<code>--resume-key r</code>
</pre></td></tr></table>
<p>This will make xnee record mouse events until you press p.
All printouts are done to stdout so you can see that Xnee stops when you
press the key.
<br>
Move your mouse for a while and you’ll see xnee print out lots of lines.
<br>
Press p.
<br>
Xnee will now have paused recording. Move your mouse for a while and note that
nothing is printed.
<br>
Press r.
<br>
Xnee will now have resumed recording. Move your mouse for a while and note that
xnee begins its printouts.
</p>
<hr size="6">
<a name="Using-macro"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Pausing-and-resuming-Xnee-with-key" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Define-a-simple-macro" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Examples" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">5.6 Using macro</h2>
<p>Macors can be used in various applications allthough many applicaions have
a macro functionality built in (e.g emacs).
</p>
<hr size="6">
<a name="Define-a-simple-macro"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Using-macro" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Define-another-simple-macro" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Using-macro" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">5.6.1 Define a simple macro</h3>
<a name="index-Define-a-simple-macro"></a>
<p>There are plenty of tools that bind a key combination to
different actions. For various reasons the author of this manual is familliar
with xrebind so we will use xrebind in this example.
<br>
The first thing to do is to decide which key combination to tie
to the wanted action. Let’s say we want to use one of the funtion keys, F1.
We then have to find out which keycode belongs to that key. The action we will
bind to this key combination will be the replaying of a recorded
session from the previous examples.
<br>
We use Xnee to find the keycode for F1. Start xnee.
</p><table><tr><td> </td><td><pre class="example"> <code>cnee --record --keyboard --events-to-record 20</code>
</pre></td></tr></table>
<p>Press the F1 key and see what number was printed out. It will look something
like this:
</p><table><tr><td> </td><td><pre class="example"><code>0,2,0,0,0,67,0,90300078</code>
<code>0,3,0,0,0,67,0,90300156</code>
</pre></td></tr></table>
<p>The interesting part here is the 6th column. In our example we find 67, which
is the keycode for F1.
<br>
Now we move on to setup xrebind to grab F1 and bind that to replay the
mouse motions from the file <code>mouse-rec.xnl</code>. Open or create a new file
in your home directory called <code>.xrbrc</code> and add the lines.
</p><table><tr><td> </td><td><pre class="example"><code>XrebindGrab</code>
<code>{</code>
<code> Action = Execute</code>
<code> GrabKeycode = 67</code>
<code> Modifier = AnyModifier</code>
<code> Command = xnee --replay --file mouse-rec.xnl</code>
<code> Comment = Starting xnee replay</code>
<code> AutoRepeat = false</code>
<code> Fork = true</code>
<code>}</code>
</pre></td></tr></table>
<p>Let’s try it. Start xrebind with verbose printouts.
</p><table><tr><td> </td><td><pre class="example"><code>xrebind --verbose</code>
</pre></td></tr></table>
<p>Press F1 and the recorded session from the previous example shall be replayed. You
can also see in the verbose printouts that xrebind executes xnee.
</p>
<hr size="6">
<a name="Define-another-simple-macro"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Define-a-simple-macro" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Various-options" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Using-macro" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">5.6.2 Define another simple macro</h3>
<a name="index-Define-another-simple-macro"></a>
<p>Let’s say we want to bind Control and e to execute the session as in the
example above. This time setting up xrebind is a bit easier.
<br>
Setup xrebind to grab F1 and bind that to replay the
mouse motions from the file <code>mouse-rec.xnl</code> by opening or create a
new file in your home directory called <code>.xrbrc</code> and add the lines.
</p><table><tr><td> </td><td><pre class="example"><code>XrebindGrab</code>
<code>{</code>
<code> Action = Execute</code>
<code> GrabKey = e</code>
<code> Modifier = Control</code>
<code> Command = xnee --replay --file mouse-rec.xnl</code>
<code> Comment = Starting xnee replay</code>
<code> AutoRepeat = false</code>
<code> Fork = true</code>
<code>}</code>
<code>e, Control, Exec, xnee, --replay --file mouse-rec.xnl, \</code>
<code>Fork, NoAutoRepeat</code>
</pre></td></tr></table>
<p>Let’s try it. Start xrebind with verbose printouts.
</p><table><tr><td> </td><td><pre class="example"><code>xrebind --verbose</code>
</pre></td></tr></table>
<p>Press Control and e and the recorded session from the previous example
shall be replayed.
</p>
<hr size="6">
<a name="Various-options"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Define-another-simple-macro" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Using-verbose-mode" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Examples" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">5.7 Various options</h2>
<hr size="6">
<a name="Using-verbose-mode"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Various-options" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Using-human-readable-printouts" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Various-options" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">5.7.1 Using verbose mode</h3>
<a name="index-Using-verbose-mode"></a>
<p>To enable verbose mode, start xnee like this
</p><table><tr><td> </td><td><pre class="example"><code>cnee --verbose --record --mouse</code>
</pre></td></tr></table>
<p>Move the mouse for a while and you’ll lots of verbose printouts that
usualy isn’t there.
</p>
<hr size="6">
<a name="Using-human-readable-printouts"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Using-verbose-mode" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Using-a-differet-screen-resolution" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Various-options" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">5.7.2 Using human readable printouts</h3>
<a name="index-Using-human-readable-printouts"></a>
<p>To enable human printout mode, start xnee like this
</p><table><tr><td> </td><td><pre class="example"><code>cnee --human-printout --record --mouse</code>
</pre></td></tr></table>
<p>Move the mouse for a while and you’ll see the data printed out in an almost
human friendly format.
</p>
<hr size="6">
<a name="Using-a-differet-screen-resolution"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Using-human-readable-printouts" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Using-a-offset-when-replaying" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Various-options" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">5.7.3 Using a differet screen resolution</h3>
<a name="index-Using-a-differet-screen-resolution"></a>
<p>If a session was recorded on a screen with another resolution than
on the one where we replay the session xnee will translate all coordinates
automagically. However, you can force xnee to use a specific resolution when
replaying. To do this, start xnee like this
</p><table><tr><td> </td><td><pre class="example"><code>cnee --replay --file mouse-rec.xnl \ </code>
<code>--replay-resolution 800x600</code>
</pre></td></tr></table>
<p>Xnee will now replay the events recorded in the sessions file
<code>mouse-rec.xnl</code> as if the screen has a resolution of 800x600.
</p>
<hr size="6">
<a name="Using-a-offset-when-replaying"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Using-a-differet-screen-resolution" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Using-a-window-position-recall" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Various-options" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">5.7.4 Using a offset when replaying</h3>
<a name="index-Using-a-offset-when-replaying"></a>
<p>If a session was recording a centered window with a window manager
and is to bo replayed without a window manager (still centered) you
can use the offset switch to make Xnee replay the events in order to
get the coordinates right.
</p><table><tr><td> </td><td><pre class="example"><code>cnee --replay --file mouse-rec.xnl \ </code>
<code>--replay-offset 12,-7</code>
</pre></td></tr></table>
<p>Xnee will now replay the events recorded in the sessions file
<code>mouse-rec.xnl</code> and adding 12 to the x coordinate and subtract
7 from the y coordinate.
</p>
<hr size="6">
<a name="Using-a-window-position-recall"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Using-a-offset-when-replaying" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Using-no-resolution-translation" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Various-options" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">5.7.5 Using a window position recall</h3>
<a name="index-Using-a-window-position-recall"></a>
<p>For some reason a replayed window may pop up at a different position
as when recorded. Xnee can try to solve this by adding the
<code>recall-window-position</code> option during replay.
</p><table><tr><td> </td><td><pre class="example"><code>cnee --replay --file mouse-rec.xnl \ </code>
<code>--recall-window-position</code>
</pre></td></tr></table>
<p>If a window pops up at a different position when replaying (as whe
recorded) Xnee moves the new window to the same position as when
recorded.
</p>
<hr size="6">
<a name="Using-no-resolution-translation"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Using-a-window-position-recall" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Record-another-display-than-the-default" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Various-options" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">5.7.6 Using no resolution translation</h3>
<a name="index-Using-no-resolution-translation"></a>
<p>If a session was recorded on a screen with another resolution than the
on the one where we replay the session xnee will translate all coordinates
automagically. However, you can force xnee not to use translation. To do this,
start xnee like this
</p><table><tr><td> </td><td><pre class="example"><code>cnee --replay --file mouse-rec.xnl \ </code>
<code>--no-resolution-adjustment</code>
</pre></td></tr></table>
<p>Xnee will now replay the events recorded in the sessions file
<code>mouse-rec.xnl</code> as if the screen had the same resolution
the recorded one.
</p>
<hr size="6">
<a name="Record-another-display-than-the-default"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Using-no-resolution-translation" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Replay-to-another-display-than-the-default" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Various-options" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">5.7.7 Record another display than the default</h3>
<a name="index-Record-another-display-than-the-default"></a>
<p>If you want to record another display than the default, as set in the
DISPLAY variable, you use the <code>--display</code> option.
</p><table><tr><td> </td><td><pre class="example"><code>cnee --record --mouse --display frodo:0.0 </code>
</pre></td></tr></table>
<p>Xnee will now record the mouse events on the display frodo:0.0.
</p>
<hr size="6">
<a name="Replay-to-another-display-than-the-default"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Record-another-display-than-the-default" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Shell-scripts-using-Xnee" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Various-options" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">5.7.8 Replay to another display than the default</h3>
<a name="index-Replay-to-another-display-than-the-default"></a>
<p>If you want to replay to another display than the default, as set in the
DISPLAY variable, you use the <code>--display</code> option.
</p><table><tr><td> </td><td><pre class="example"><code>cnee --replay --display frodo:0.0 --file mouse-rec.xnl </code>
</pre></td></tr></table>
<p>Xnee will now replay the mouse events on the display frodo:0.0.
</p>
<hr size="6">
<a name="Shell-scripts-using-Xnee"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Replay-to-another-display-than-the-default" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Examples" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">5.8 Shell scripts using Xnee</h2>
<a name="index-Shell-scripts-using-Xnee"></a>
<p>Insted of onvoking Xnee for every time you need to fake events
you can make use of the shell functions as delivered with Xnee.
With these functions you can start one instance of Xnee and fake
device events whenever you need.
</p><table><tr><td> </td><td><pre class="example">
<code>#!/bin/bash </code>
<code> </code>
<code># Source in handy functions </code>
<code>. /usr/share/xnee/xnee.sh </code>
<code> </code>
<code># Loop and press buttons </code>
<code>TMP=0 </code>
<code>while [ $TMP -le 5]</code>
<code>do</code>
<code> TMP=$(($TMP+1))</code>
<code> xnee_fake_button $TMP </code>
<code>done</code>
<code> </code>
<code># Just a simple example ....don't bother to understand </code>
<code>tar cvf /tmp/crap.tar *</code>
<code>sleep 2</code>
<code> </code>
<code># Fake ls and Enter </code>
<code>xnee_fake_key l</code>
<code>xnee_fake_key s</code>
<code>xnee_fake_key XK_Return</code>
<code> </code>
<code> </code>
</pre></td></tr></table>
<p>This example will fake press and release of the mouse button and
do fake press and release of ls followed by a press and release
of Enter.... and of course, you’ll get a tar file in /tmp.
</p>
<p>Make sure that the path to the <code>xnee.sh</code> is correct.
</p>
<hr size="6">
<a name="Programs"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Shell-scripts-using-Xnee" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#cnee-_002d-cnee_0027s-not-an-event-emulator" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Examples" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#File-format" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Xnee-Programs"></a>
<h1 class="chapter">6. Xnee Programs</h1>
<p>GNU Xnee consists of three different programs, cnee, gnee and pnee.
</p>
<hr size="6">
<a name="cnee-_002d-cnee_0027s-not-an-event-emulator"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Programs" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#gnee-_002d-gnee_0027s-not-an-emulator-either" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Programs" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#File-format" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">6.1 cnee - cnee’s not an event emulator</h2>
<p>This is the Xnee command line program. This programs contains most
features and is the basis for this documentation.
</p>
<p>For a user not used to X11 it is probably a good idea to start with
gnee or pnee instead or start using cnee in demonstration mode:
<code>cnee --demo</code>
</p>
<hr size="6">
<a name="gnee-_002d-gnee_0027s-not-an-emulator-either"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#cnee-_002d-cnee_0027s-not-an-event-emulator" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#pnee-_002d-pnee_0027s-not-even-emulating" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Programs" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#File-format" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">6.2 gnee - gnee’s not an emulator either</h2>
<p>This is a GUI (using GTK2/Gnome) with most of the features of
cnee. The GUI has been designed for ease of use.
</p>
<p>Currently there are no plans for making a separate manual for gnee.
</p>
<hr size="6">
<a name="pnee-_002d-pnee_0027s-not-even-emulating"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#gnee-_002d-gnee_0027s-not-an-emulator-either" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Reporting-pnee-bugs" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Programs" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Programs" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#File-format" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">6.3 pnee - pnee’s not even emulating</h2>
<p>This is a Gnome panel applet with a minimal set of features. Ease of
use is the motto for this program. It is intended for users not being
experts on X11 but still wants to record and replay a session for what
ever purpose. By default pnee have settings that need not be changed
for most cases. You can, however, launch the preferences dialog and
set your preferred values as in most other applets.
</p>
<p>If you find pnee a bit limited we suggest you switch over to using
cnee.
</p>
<p><b>Note</b>: If pnee hangs you can press the stop button twice to make a
reset. Hopefully this will solve the problem.
</p>
<hr size="6">
<a name="Reporting-pnee-bugs"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#pnee-_002d-pnee_0027s-not-even-emulating" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#File-format" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Programs" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#pnee-_002d-pnee_0027s-not-even-emulating" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#File-format" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">6.3.1 Reporting pnee bugs</h3>
<a name="index-Reporting-pnee-bugs"></a>
<p>By default pnee writes error, verbose printouts and warnings to stderr
which will not be visible to you as a user, since pnee will be started
automatically along with the other applets. If you start up the
preferences dialog you can choose a file for pnee printouts. After
that you should turn on verbose logging (also in the preferences
dialog) and then reproduce the bug and send over the file to
<a href="mailto:xnee-bug@gnu.org">xnee-bug@gnu.org</a>.
</p>
<hr size="6">
<a name="File-format"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Reporting-pnee-bugs" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Project-file-1" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Programs" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Internals" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="File-types-and-format"></a>
<h1 class="chapter">7. File types and format</h1>
<p>The files used by Xnee are
</p><ul>
<li> Xnee Project File
</li><li> Xnee Session File
</li></ul>
<p>These files must follow the Xnee File Format.
</p>
<hr size="6">
<a name="Project-file-1"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#File-format" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Create-a-project-file" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#File-format" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#File-format" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Internals" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">7.1 Project file</h2>
<a name="index-Project-file"></a>
<p>Xnee can be set either using command line options (when using xnee) or by
clicking the correct buttons etc in the GUI (using gnee). Instead of setting
the same settings over and over again, you can use the Xnee Project File.
</p>
<hr size="6">
<a name="Create-a-project-file"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Project-file-1" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Xnee-Session-file" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#File-format" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Project-file-1" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Internals" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">7.1.1 Create a project file</h3>
<a name="index-Create-a-project-file"></a>
<p>You can create a project by yourself. This can be done using
the <code>write-settings</code> option in cnee or the “save settings to file”
when using gnee or you can use the Xnee GUI (gnee) to write one.
You can also write one by yourself in your favorite editor. Just make sure you
follow the Xnee format. For information and specification on this format read
the Xnee format chapter.
</p>
<p>The authors of Xnee suggests you start off with a generated project file. To get one
such file, type the following
<code>cnee --mouse --keyboard --write-settings new_proj.xnp</code>. You will now
have a file <code>new_proj.xnp</code> with some useful values, which you can edit as you wish.
</p>
<p>To use this file to record, simply type
<code>cnee --record --project new_proj.xnp</code>
</p>
<hr size="6">
<a name="Xnee-Session-file"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Create-a-project-file" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Xnee-file-format" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#File-format" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#File-format" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Internals" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">7.2 Xnee Session file</h2>
<a name="index-Session-file"></a>
<p>The Xnee session files are the printouts from a recorded session
following the Xnee File Format. For information and specification on
this format read the Xnee File Format chapter.
</p>
<hr size="6">
<a name="Xnee-file-format"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Xnee-Session-file" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Xnee-directives" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#File-format" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#File-format" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Internals" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">7.3 Xnee file format</h2>
<p>The Xnee Format is divided into different directives.
The format is line based, meaning that
</p>
<ul>
<li> there is one directive per line
</li><li> one line contains one (and only one) directive
</li></ul>
<p>These directives are definied as follows.
</p>
<hr size="6">
<a name="Xnee-directives"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Xnee-file-format" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Comment" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#File-format" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#File-format" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Internals" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">7.4 Xnee directives</h2>
<p>The following directives are used in Xnee:
</p><table>
<tr><td width="0%"></td><td width="30%"><b>Directives</b></td><td width="70%"><b>Description</b></td></tr>
<tr><td width="0%"></td><td width="30%">Comment</td><td width="70%">This is used to comment the various files</td></tr>
<tr><td width="0%"></td><td width="30%">Project</td><td width="70%">These contains information about the session- or project file</td></tr>
<tr><td width="0%"></td><td width="30%">Settings</td><td width="70%">Data used when recording and replaying</td></tr>
<tr><td width="0%"></td><td width="30%">Replay data</td><td width="70%">Recorded replayable data (used when replaying)</td></tr>
<tr><td width="0%"></td><td width="30%">Script replay data</td><td width="70%">Scriptable primitives</td></tr>
<tr><td width="0%"></td><td width="30%">Mark</td><td width="70%">Lines inserted in the seesion file when a modifier+key was pressed</td></tr>
<tr><td width="0%"></td><td width="30%">Execution</td><td width="70%">Lines that trigger the execution of an external program</td></tr>
<tr><td width="0%"></td><td width="30%">Project information</td><td width="70%">Project</td></tr>
</table>
<hr size="6">
<a name="Comment"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Xnee-directives" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Settings" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#File-format" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Xnee-directives" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Internals" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">7.4.1 Comment</h3>
<a name="index-Comment-directives"></a>
<table>
<tr><td width="0%"></td><td width="20%"><b>First token</b></td><td width="50%"><b>Interpretation</b></td></tr>
<tr><td width="0%"></td><td width="20%">#</td><td width="50%">The whole line is ignored.</td></tr>
</table>
<p>As long as the first token is <code>#</code> the whole line is intrepreted as a comment, just
as in bash.
</p>
<hr size="6">
<a name="Settings"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Comment" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Replay-1" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#File-format" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Xnee-directives" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Internals" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">7.4.2 Settings</h3>
<a name="index-Settings"></a>
<table>
<tr><td width="45%"><b>Settings directive</b></td><td width="15%"><b>Argument</b></td><td width="60%"><b>Interpretation</b></td></tr>
<tr><td width="45%">data-to-record</td><td width="15%">integer</td><td width="60%">Limits the number of data to record to to the integer value</td></tr>
<tr><td width="45%">events-to-record</td><td width="15%">integer</td><td width="60%">Limits the number of events to record to to the integer value</td></tr>
<tr><td width="45%">time-to-record</td><td width="15%">integer</td><td width="60%">Limits the number of seconds to record to to the integer value</td></tr>
<tr><td width="45%">display</td><td width="15%">string</td><td width="60%">Sets the display to record or replay to the string</td></tr>
<tr><td width="45%">distribute</td><td width="15%">string</td><td width="60%">Distribute all recorded or replayed replayable events to the display given by the string</td></tr>
<tr><td width="45%">file</td><td width="15%">string</td><td width="60%">Read replay data from the file given by the string</td></tr>
<tr><td width="45%">out-file</td><td width="15%">string</td><td width="60%">Print recorded data to the file given by the string</td></tr>
<tr><td width="45%">plugin</td><td width="15%">string</td><td width="60%">Use the plugin given by the string</td></tr>
<tr><td width="45%">first-last</td><td width="15%">boolean</td><td width="60%">Print only first and last of successive MotionNotify events</td></tr>
<tr><td width="45%">verbose</td><td width="15%">boolean</td><td width="60%">Use verbose debugging printout</td></tr>
<tr><td width="45%">buffer-verbose</td><td width="15%">boolean</td><td width="60%">Use verbose buffer verbose printouts (not built by default)</td></tr>
<tr><td width="45%">time</td><td width="15%">integer</td><td width="60%">Delay the start of the Xnee action</td></tr>
<tr><td width="45%">all-clients</td><td width="15%">boolean</td><td width="60%">Record all curret and future clients (default)</td></tr>
<tr><td width="45%">future-clients</td><td width="15%">boolean</td><td width="60%">Record only future clients</td></tr>
<tr><td width="45%">human-printout</td><td width="15%">boolean</td><td width="60%">Prints the recorded data in a (quite) more ser friendly format</td></tr>
<tr><td width="45%">sync-mode</td><td width="15%">boolean</td><td width="60%">Sets recording mode</td></tr>
<tr><td width="45%">speed-percent</td><td width="15%">integer</td><td width="60%">Sets the replaying speed percentage to the integer value</td></tr>
<tr><td width="45%">stop-key</td><td width="15%"><acronym>string</acronym></td><td width="60%">Sets the stop key combination to the string</td></tr>
<tr><td width="45%">pause-key</td><td width="15%"><acronym>string</acronym></td><td width="60%">Sets the pause key combination to the string</td></tr>
<tr><td width="45%">resume-key</td><td width="15%"><acronym>string</acronym></td><td width="60%">Sets the resume key combination to the string</td></tr>
<tr><td width="45%">mark-key</td><td width="15%"><acronym>string</acronym></td><td width="60%">Sets the mark key combination to the string</td></tr>
<tr><td width="45%">exec-key</td><td width="15%"><acronym>string</acronym></td><td width="60%">Sets the execute key combination to string</td></tr>
<tr><td width="45%">replay-resolution</td><td width="15%">string</td><td width="60%">Sets the replay resolution to the string</td></tr>
<tr><td width="45%">replay-resolution</td><td width="15%">string</td><td width="60%">Sets the replay resolution to the string</td></tr>
<tr><td width="45%">recall-window-position</td><td width="15%"></td><td width="60%">Use window position recall during replay</td></tr>
<tr><td width="45%">resolution-adjustment</td><td width="15%">boolean</td><td width="60%">Use resolution adjustment, even if the recored resolution differs from the one to replay to</td></tr>
<tr><td width="45%">event-range</td><td width="15%">range</td><td width="60%">Sets the events to record</td></tr>
<tr><td width="45%">error-range</td><td width="15%">range</td><td width="60%">Sets the errors to record to range*</td></tr>
<tr><td width="45%">request-range</td><td width="15%">range</td><td width="60%">Sets the request to record to range*</td></tr>
<tr><td width="45%">reply-range</td><td width="15%">range</td><td width="60%">Sets the replies to record to range*</td></tr>
<tr><td width="45%">extension-request-major-range</td><td width="15%">range</td><td width="60%">Sets the extension requests (major) to record to range*</td></tr>
<tr><td width="45%">extension-request-minor-range</td><td width="15%">range</td><td width="60%">Sets the extension requests (minor) to record to range*</td></tr>
<tr><td width="45%">extension-reply-major-range</td><td width="15%">range</td><td width="60%">Sets the extension replies (major) to record to range*</td></tr>
<tr><td width="45%">extension-reply-minor-range</td><td width="15%">range</td><td width="60%">Sets the extension replies (minor) to record to range*</td></tr>
<tr><td width="45%">force-replay</td><td width="15%">boolean</td><td width="60%">Continue to replay even if Xnee is out of sync</td></tr>
<tr><td width="45%">max-threshold</td><td width="15%">integer</td><td width="60%">Sets the maximum synchronisation threshold</td></tr>
<tr><td width="45%">min-threshold</td><td width="15%">integer</td><td width="60%">Sets the minimum synchronisation threshold</td></tr>
<tr><td width="45%">total-threshold</td><td width="15%">integer</td><td width="60%">Sets the total maximum synchronisation threshold</td></tr>
<tr><td width="45%">events-to-record</td><td width="15%">integer</td><td width="60%">Sets the number of events to record</td></tr>
<tr><td width="45%">data-to-record</td><td width="15%">integer</td><td width="60%">Sets the number of data to record</td></tr>
<tr><td width="45%">time-to-record</td><td width="15%">integer</td><td width="60%">Sets the number of seconds to record</td></tr>
<tr><td width="45%">store-mouse-position</td><td width="15%"></td><td width="60%">If set, Xnee records the initial mouse position and makes sure that replaying starts from there</td></tr>
<tr><td width="45%">retype-press-delay</td><td width="15%">integer</td><td width="60%">Xnee delays processing after a faked key press (during retype)
with integer milli seconds</td></tr>
<tr><td width="45%">retype-release-delay</td><td width="15%">integer</td><td width="60%">Xnee delays processing after a faked key press (during retype)
with integer milli seconds</td></tr>
</table>
<a name="index-Xnee-Settings-Arguments"></a>
<table>
<tr><td width="30%"><b>Settings argument</b></td><td width="40%"><b>Description</b></td><td width="30%"><b>Example</b></td></tr>
<tr><td width="30%"><code>integer</code></td><td width="40%">is an integer value.</td><td width="30%">1</td></tr>
<tr><td width="30%"><code>string</code></td><td width="40%">is a string.</td><td width="30%">localhost</td></tr>
<tr><td width="30%"><code>boolean</code></td><td width="40%">is a boolean value given by true/1 or false/0</td><td width="30%">true, false, 0, 1</td></tr>
<tr><td width="30%"><code>subrange</code></td><td width="40%">Subrange is gives a range of data by specifying a start and stop
data. In the case of one data the stop data can be omitted.</td><td width="30%">2-5 or MapNotify</td></tr>
<tr><td width="30%"><code>range</code></td><td width="40%">Ranges are a comma separated list of subranges.</td><td width="30%">2-3,MotionNotify-MapNotify,GravityNotify,PropertyNotify,30</td></tr>
</table>
<hr size="6">
<a name="Replay-1"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Settings" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Script-replay-data" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#File-format" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Xnee-directives" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Internals" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">7.4.3 Replay</h3>
<a name="index-Replay-directive"></a>
<table>
<tr><td width="40%"><b>Replay directive</b></td><td width="60%"><b>Interpretation</b></td></tr>
<tr><td width="40%">0,0</td><td width="60%">not valid</td></tr>
<tr><td width="40%">0,1</td><td width="60%">not valid</td></tr>
<tr><td width="40%">0,2,void,void,void,keycode,screen,time</td><td width="60%">KeyPress on key with keycode, used to replay</td></tr>
<tr><td width="40%">0,3,void,void,void,keycode,screen,time</td><td width="60%">KeyRelease on key with keycode, used to replay</td></tr>
<tr><td width="40%">0,4,void,void,button nr,void,screen,time</td><td width="60%">ButtonPress on button nr, used to replay</td></tr>
<tr><td width="40%">0,5,void,void,button nr,void,screen,time</td><td width="60%">ButtonRelease on button nr, used to replay</td></tr>
<tr><td width="40%">0,6,x,y,void,void,screen,time</td><td width="60%">MotionNotify on poistion (x,y), used to replay</td></tr>
<tr><td width="40%">1,request number, request type, length, request id, time</td><td width="60%">Recorded request, used during synchronisation</td></tr>
<tr><td width="40%">2,reply number,time</td><td width="60%">Recorded reply, used during synchronisation</td></tr>
<tr><td width="40%">3,error number,time</td><td width="60%">Recorded error, used during synchronisation</td></tr>
<tr><td width="40%">6,EB+2,void,void,void,keycode,screen,time</td><td width="60%">X Input (master) KeyPress on key with keycode, used to replay</td></tr>
<tr><td width="40%">6,EB+3,void,void,void,keycode,screen,time</td><td width="60%">X Input (master) KeyRelease on key with keycode, used to replay</td></tr>
<tr><td width="40%">6,EB+4,void,void,button nr,void,screen,time</td><td width="60%">X Input (master) ButtonPress on button nr, used to replay</td></tr>
<tr><td width="40%">6,EB+5,void,void,button nr,void,screen,time</td><td width="60%">X Input (master) ButtonRelease on button nr, used to replay</td></tr>
<tr><td width="40%">6,EB+6,x,y,void,void,screen,time</td><td width="60%">X Input (master) MotionNotify on poistion (x,y), used to replay</td></tr>
<tr><td width="40%">6,EB+2,void,void,void,keycode,screen,time</td><td width="60%">X Input (slave) KeyPress on key with keycode, used to replay</td></tr>
<tr><td width="40%">6,EB+3,void,void,void,keycode,screen,time</td><td width="60%">X Input (slave) KeyRelease on key with keycode, used to replay</td></tr>
<tr><td width="40%">6,EB+4,void,void,button nr,void,screen,time</td><td width="60%">X Input (slave) ButtonPress on button nr, used to replay</td></tr>
<tr><td width="40%">6,EB+5,void,void,button nr,void,screen,time</td><td width="60%">X Input (slave) ButtonRelease on button nr, used to replay</td></tr>
<tr><td width="40%">6,EB+6,x,y,void,void,screen,time</td><td width="60%">X Input (slave) MotionNotify on poistion (x,y), used to replay</td></tr>
</table>
<p>time is the time on the server the data was to the recording Xnee
client. This time is used to keep the speed intact during replay.
</p>
<hr size="6">
<a name="Script-replay-data"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Replay-1" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Mark" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#File-format" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Xnee-directives" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Internals" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">7.4.4 Script replay data</h3>
<a name="index-Script-replay-data"></a>
<table>
<tr><td width="40%"><b>Primitive</b></td><td width="60%"><b>Interpretation</b></td></tr>
<tr><td width="40%">fake-motion</td><td width="60%">Fakes a mouse motion</td></tr>
<tr><td width="40%">fake-button-press</td><td width="60%">Fakes a button press</td></tr>
<tr><td width="40%">fake-button-release</td><td width="60%">Fakes a button release</td></tr>
<tr><td width="40%">fake-button</td><td width="60%">Fakes a button press and release</td></tr>
<tr><td width="40%">fake-key-press</td><td width="60%">Fakes a key press</td></tr>
<tr><td width="40%">fake-key-release</td><td width="60%">Fakes a key release</td></tr>
<tr><td width="40%">fake-key</td><td width="60%">Fakes a key press and release</td></tr>
</table>
<table>
<tr><td width="20%"><b>Primitive variable</b></td><td width="20%"><b>Primitive values</b></td><td width="60%"><b>Interpretation</b></td></tr>
<tr><td width="20%">x=value</td><td width="20%">integer</td><td width="60%">Sets the x position used in fake-motion to value</td></tr>
<tr><td width="20%">x=value</td><td width="20%">+integer</td><td width="60%">Set the relative motion (x direction) used in fake-motion to value</td></tr>
<tr><td width="20%">x=value</td><td width="20%">-integer</td><td width="60%">Set the relative motion (x direction) used in fake-motion to value</td></tr>
<tr><td width="20%">y=value</td><td width="20%">integer</td><td width="60%">Sets the y position used in fake-motion to value</td></tr>
<tr><td width="20%">y=value</td><td width="20%">+integer</td><td width="60%">Set the relative motion (y direction) used in fake-motion to value</td></tr>
<tr><td width="20%">y=value</td><td width="20%">-integer</td><td width="60%">Set the relative motion (y direction) used in fake-motion to value</td></tr>
<tr><td width="20%">button=value</td><td width="20%">integer</td><td width="60%">set the button to fake with fake-button-press, fake-button-release and fake-button to value</td></tr>
<tr><td width="20%">key=value</td><td width="20%">integer</td><td width="60%">set the key to fake with fake-key-press, fake-key-release and fake-key to value</td></tr>
</table>
<hr size="6">
<a name="Mark"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Script-replay-data" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Exec" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#File-format" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Xnee-directives" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Internals" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">7.4.5 Mark</h3>
<a name="index-Mark-directive"></a>
<table>
<tr><td width="20%"><b>First tokens</b></td><td width="20%"><b>Arguments</b></td><td width="60%"><b>Interpretation</b></td></tr>
<tr><td width="20%">Mark</td><td width="20%">time string</td><td width="60%">Ignored. This feature is intended to let the user do whatever he/she
wants to. This will obviously lead to modifying the source code etc.</td></tr>
</table>
<hr size="6">
<a name="Exec"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Mark" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Project-information" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#File-format" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Xnee-directives" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Internals" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">7.4.6 Exec</h3>
<a name="index-Exec-directive"></a>
<table>
<tr><td width="20%"><b>First tokens</b></td><td width="20%"><b>Arguments</b></td><td width="60%"><b>Interpretation</b></td></tr>
<tr><td width="20%">Exec</td><td width="20%">command string</td><td width="60%">This is used during to replay to execute a given command. If no
command string is found Xnee will try to
read the command from the environment variable <code>XNEE_EXEC_COMMAND</code></td></tr>
</table>
<hr size="6">
<a name="Project-information"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Exec" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Internals" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#File-format" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Xnee-directives" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Internals" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">7.4.7 Project information</h3>
<a name="index-Project-information-directive"></a>
<table>
<tr><td width="45%"><b>Project information directives</b></td><td width="55%"><b>Arguments</b></td></tr>
<tr><td width="45%">ProjectName</td><td width="55%">string s is the project name</td></tr>
<tr><td width="45%">ProjectDescription</td><td width="55%">string s is the project description</td></tr>
<tr><td width="45%">ProjectCreationDate</td><td width="55%">string s is the project creation date</td></tr>
<tr><td width="45%">ProjectCreationProgram</td><td width="55%">string s is the name of the program that create the project file</td></tr>
<tr><td width="45%">ProjectCreationProgVersion</td><td width="55%">string s is the version of the program that create the project file</td></tr>
<tr><td width="45%">ProjectLastChangeDate</td><td width="55%">string s is the date of the last change of the project file</td></tr>
<tr><td width="45%">ProjectLastChangeProgram</td><td width="55%">string s is the name of the program that last changed of the project file</td></tr>
<tr><td width="45%">ProjectLastChangeVersion</td><td width="55%">string s is the version of the program that last changed of the project file</td></tr>
<tr><td width="45%">ProjectCurrentChangeDate</td><td width="55%">string s is the date of the current change of the project file</td></tr>
<tr><td width="45%">ProjectCurrentChangeProgram</td><td width="55%">string s is the name of the program that current changed of the project file</td></tr>
<tr><td width="45%">ProjectCurrentChangeVersion</td><td width="55%">string s is the version of the program that current changed of the project file</td></tr>
</table>
<hr size="6">
<a name="Internals"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Project-information" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Synchronisation" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#File-format" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Requirements" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Xnee-Internals"></a>
<h1 class="chapter">8. Xnee Internals</h1>
<a name="index-Xnee-Internals"></a>
<p>This chapter is intended to explain the internal design of libxnee.
Hopefully this will lead to a better understanding of how to use Xnee
and why some features exist and why some don’t.
</p>
<hr size="6">
<a name="Synchronisation"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Internals" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Why-synchronise" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Internals" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Internals" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Requirements" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">8.1 Synchronisation</h2>
<a name="index-Synchronisation"></a>
<p>We will try to go through the basics of how Xnee implements synchronisation
and try to tell you, by using examples, why synhronisation is important.
</p>
<hr size="6">
<a name="Why-synchronise"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Synchronisation" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#How-to-synchronise" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Internals" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Synchronisation" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Requirements" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">8.1.1 Why synchronise</h3>
<a name="index-why-synchronise"></a>
<p>To understand why synchronisation during replay is needed an example is given.
</p>
<p>In this example only mouse and keyboard events are recorded. Think of a session with a web browser.
</p>
<p>During record the following is done:
</p><ul>
<li> Start galeon (or another web browser) via the GNOME panel
</li><li> Press Ctrl-O which pops up a window
</li><li> Press the left button in the textfield of the popup window
</li><li> Enter the URL you want to enter (e.g <a href="http://www.gnu.org">http://www.gnu.org</a>)
</li><li> Click on the OK button
</li><li> Then click on another URL (e.g GNU Documentation)
</li><li> Then click on another URL (e.g On-Line Documentation)
</li></ul>
<p>When replaying this session it is often useful to synchronise the recorded session with what’s happening "right now" on the display since sometimes (or rather always) there can be different response times from the same URL.
</p>
<p>During replay the following is done:
</p><ul>
<li> Galeon is started
</li><li> Ctrl-O is typed which pops up a window
</li><li> Press the left button in the textfield of the popup window
</li><li> Enter the URL you want to enter (e.g <a href="http://www.gnu.org">http://www.gnu.org</a>)
</li><li> Click on the OK button
</li><li> ... due to an enormous amount of visitors the GNU web server can’t respond as quick as it did when recording. So when the next thing happens
</li><li> Then click on another URL (e.g GNU Documentation)
</li><li> ... the page hasn’t been loaded and when the next event is replayed
</li><li> Then click on another URL (e.g On-Line Documentation)
</li><li> ... the link isn’t there and we’re really out of sync with the recorded session
</li></ul>
<hr size="6">
<a name="How-to-synchronise"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Why-synchronise" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Synchronisation-is-needed" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Internals" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Synchronisation" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Requirements" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">8.1.2 How to synchronise</h3>
<a name="index-how-to-synchronise"></a>
<p>Instead we could record some more data than just the mouse and keyboard events.
</p>
<p>During record the following is done:
</p><ul>
<li> Start galeon (or another web browser) via the GNOME panel
</li><li> Record some X data that tells us that a window has been created
</li><li> Press Ctrl-O which pops up a window
</li><li> Record some X data that tells us that a window has been created
</li><li> Press the left button in the textfield of the popup window
</li><li> Enter the URL you want to enter (e.g <a href="http://www.gnu.org">http://www.gnu.org</a>)
</li><li> Click on the OK button
</li><li> Record some X data that tells us that a window has been destroyed
</li><li> Then click on another URL (e.g GNU Documentation)
</li><li> Record some X data that tells us that a some text has been displayed in a window
</li><li> Then click on another URL (e.g On-Line Documentation)
</li><li> Record some X data that tells us that a some text has been displayed in a window
</li></ul>
<p>The non-mouse-or-keyboard events recorded (window created & text displayed) are record for synchronisation purposes.
</p>
<p>During replay the following is done:
</p><ul>
<li> Start galeon (or another web browser) via the GNOME panel
</li><li> wait for: the recorded X data to be sent again
</li><li> Press Ctrl-O which pops up a window
</li><li> wait for: the recorded X data to be sent again
</li><li> Press the left button in the textfield of the popup window
</li><li> Enter the URL you want to enter (e.g <a href="http://www.gnu.org">http://www.gnu.org</a>)
</li><li> Click on the OK button
</li><li> wait for: the recorded X data to be sent again
</li><li> Then click on another URL (e.g GNU Documentation)
</li><li> wait for: the recorded X data to be sent again
</li><li> Then click on another URL (e.g On-Line Documentation)
</li><li> wait for: the recorded X data to be sent again
</li></ul>
<hr size="6">
<a name="Synchronisation-is-needed"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#How-to-synchronise" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Different-data-for-different-kind-of-sessions" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Internals" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Synchronisation" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Requirements" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">8.1.3 Synchronisation is needed</h3>
<p>So by recording more data than just the events to be replayed we can synchornise what was recorded with what is going on when replaying. But the data has to be chosen with respect to that the data:
</p><ul>
<li> differs from different sessions (Gimp and Xterm are really different)
</li><li> slows down the replay session if there are too many
</li><li> is hard to choose since the X protocol is rich
</li><li> differs (comparing record and replaying)
</li><li> can have different ordering (comparing record and replaying)
</li></ul>
<hr size="6">
<a name="Different-data-for-different-kind-of-sessions"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Synchronisation-is-needed" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Slow-replay-session-due-to-too-many-synchronise-data" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Internals" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Synchronisation" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Requirements" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">8.1.4 Different data for different kind of sessions</h3>
<p>If we record an xterm session with all data being recorded and compare that to a recorded GIMP session with all data being recordr we can see that the data to use as synchronisation data differs. AS an example there aren’t so many windows created/destryed during an xterm session.
</p>
<p>The solve to the the problem of finding out what data to use as synchronisation data one can:
</p><ul>
<li> use the project files delivered with Xnee
</li><li> analyse the application (using Xnee’s <code>--human-printouts</code> option) and do some "trial and error"
</li></ul>
<hr size="6">
<a name="Slow-replay-session-due-to-too-many-synchronise-data"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Different-data-for-different-kind-of-sessions" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#X-protocol-is-rich-and-asynchronous" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Internals" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Synchronisation" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Requirements" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">8.1.5 Slow replay session due to too many synchronise data</h3>
<p>The synchronisation itself doesn’t take much time but there are timeouts that makes Xnee paues for a short while (see above). If there are many such timeouts it will lead to a slow or shaky replaying session.
</p>
<hr size="6">
<a name="X-protocol-is-rich-and-asynchronous"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Slow-replay-session-due-to-too-many-synchronise-data" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Different-data-sent" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Internals" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Synchronisation" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Requirements" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">8.1.6 X protocol is rich and asynchronous</h3>
<p>For an end user (with no X expertise) it is hard to read the X protocol specification and make assumptions on what data to use.
</p>
<hr size="6">
<a name="Different-data-sent"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#X-protocol-is-rich-and-asynchronous" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Buffers-and-timeouts" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Internals" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Synchronisation" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Requirements" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">8.1.7 Different data sent</h3>
<p>Even if one starts up a machine from scratch (reboot) when recording and from scratch when replaying there is no guarantee that the data is sent in the same order or that exactly the same amount of data is sent.
</p>
<hr size="6">
<a name="Buffers-and-timeouts"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Different-data-sent" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Requirements" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Internals" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Synchronisation" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Requirements" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection">8.1.8 Buffers and timeouts</h3>
<p>To enable synchronisation Xnee buffers data:
</p><ul>
<li> that was read in the session file but hasn’t been sent during replay
</li><li> that was sent during replay but hasn’t been seen in the session
file being replayed
</li></ul>
<p>For every data read from session file (during replay) that isn’t replayable
(i e device event) Xnee stores the data in a buffer. Xnee also stores the
data sent from the X server during playback. The data received from the server
make the buffer entry for that specific data be decremented. If, on the other
hand, the same data was read from file the buffer entry for that data is
incremented.
Before replaying any replayable event Xnee makes sure it is in sync. If Xnee
is in sync the replaying
continues. If Xnee is out of sync it will look for its thresholds and see
if it is inside a user specified range. There are three thresholds:
</p><ul>
<li> <b>positive maximum</b> nr data read from session file
</li><li> <b>negative minimum</b> nr of data sent from X server
</li><li> <b>absolute total maximum</b> sum of the absolute values above
</li></ul>
<p>If Xnee read one data from file (e.g the event MapNotify) Xnee checks if the
buffer entry for the specific data is bigger than the positive maximum value
(after having incremented the buffer value).
</p>
<p>If Xnee receives one data from the X server (e.g the event MapNotify) it
checks if the buffer entry for the specific data is bigger than the
negative minimum value (after having decremented the buffer value).
</p>
<p>Xnee also checks if the absolute sum of the differences for every entry
in the buffer is higher the a total threshold.
</p>
<p>If Xnee is getting out of sync it slows down the speed a bit and tries to
continue. However after a while it may happen that Xnee considers that it
no use to continue since we are too much out of sync.
<br>
Xnee compensates for the delay during replay that is caused when being out of
sync.
<br>
It is possible to tweak the thresholds using the <code>--maximum-threshold</code>,
<code>--negative-threshold</code> and <code>--total-diff-threshold</code> options. Is is
also possible to turn off synchronisation completely using the <code>-ns</code>
option.
</p>
<hr size="6">
<a name="Requirements"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Buffers-and-timeouts" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Runtime-requirements" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Internals" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#FAQ" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Xnee-Requirements"></a>
<h1 class="chapter">9. Xnee Requirements</h1>
<a name="index-requirements"></a>
<hr size="6">
<a name="Runtime-requirements"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Requirements" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Development-requirements" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Requirements" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Requirements" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#FAQ" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">9.1 Runtime requirements</h2>
<a name="index-runtime-requirements"></a>
<p>Xnee requirements:
</p><ul>
<li> RECORD extension
</li><li> XTest extension
</li></ul>
<p>You can use Xnee in replaying mode without RECORD extension if synchronisation is turned off.
</p>
<hr size="6">
<a name="Development-requirements"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Runtime-requirements" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#FAQ" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Requirements" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Requirements" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#FAQ" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section">9.2 Development requirements</h2>
<a name="index-development-requirements"></a>
<p>For development requirements, please look at the DEVELOPMENT file that is distributed with all packages and with CVS.
</p>
<hr size="6">
<a name="FAQ"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Development-requirements" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Copying-This-Manual" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Requirements" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Copying-This-Manual" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="FAQ-1"></a>
<h1 class="chapter">10. FAQ</h1>
<dl compact="compact">
<dt> ‘<samp>Where do I send questions?</samp>’</dt>
<dd><a name="index-questions-is-sent-where_003f"></a>
<p><a href="mailto:xnee-devel@gnu.org">xnee-devel@gnu.org</a>
<br>
</p>
</dd>
<dt> ‘<samp>Where and how do I report bugs?</samp>’</dt>
<dd><a name="index-Report-bugs_003f"></a>
<p>Turn on verbose mode <code>cnee --verbose</code> and save the printouts.
Include all printouts and log files in the mail which is sent to
<a href="mailto:bug-xnee@gnu.org">bug-xnee@gnu.org</a>
<br>
</p>
</dd>
<dt> ‘<samp>Can you add xxx functionality to Xnee</samp>’</dt>
<dd><p> Send an email to <a href="mailto:xnee-devel@gnu.org">xnee-devel@gnu.org</a> and we’ll consider it.
</p>
</dd>
<dt> ‘<samp>Why the name Xnee?</samp>’</dt>
<dd><a name="index-why-name-it-Xnee"></a>
<p>We wanted to use a recursive acronym, as GNU (“GNU’s Not Unix’).
After having read the Wine documentation, we thought that Xnee is not an
Event Emulator would work fine since Xnee is Not an Event Emulator but
rather a event recorder and faker.
</p>
</dd>
<dt> ‘<samp>What does the name cnee mean?</samp>’</dt>
<dd><a name="index-What-does-the-name-cnee-mean_003f"></a>
<p> cnee’s not an event emulator
</p>
</dd>
<dt> ‘<samp>What does the name gnee mean?</samp>’</dt>
<dd><a name="index-What-does-the-name-gnee-mean_003f"></a>
<p> gnee’s not an emulator either
</p>
</dd>
<dt> ‘<samp>What does the name pnee mean?</samp>’</dt>
<dd><a name="index-What-does-the-name-gnee-mean_003f-1"></a>
<p> pnee’s not even emulating
</p>
</dd>
<dt> ‘<samp>What doesn't the name gnee mean?</samp>’</dt>
<dd><a name="index-What-does-the-name-gnee-mean_003f-2"></a>
<p> gnee’s not an Event Emulator
</p>
</dd>
<dt> ‘<samp>What license is Xnee released under ?</samp>’</dt>
<dd><a name="index-license"></a>
<p>GPL version two or later. Which can be found at
<a href="http://www.gnu.org/copyleft/gpl.html">http://www.gnu.org/copyleft/gpl.html</a>. Xnee will switch to GPLv3
as soon as GPLv3 is released.
</p>
</dd>
<dt> ‘<samp>Where is the CVS repository?</samp>’</dt>
<dd><p>You can find a CVS tree at <a href="http://savannah.gnu.org">http://savannah.gnu.org</a>.
You are more than welcome to join
</p>
</dd>
<dt> ‘<samp>Is there a GUI frontend for Xnee ?</samp>’</dt>
<dd><a name="index-GUI-frontend-for-Xnee"></a>
<p>Yes! Gnee.
</p>
</dd>
<dt> ‘<samp>When setting ranges (integers), how do I know what numbers belong</samp>’ </dt>
<dd><p>to X11 data?
<a name="index-what-numbers-belong-to-X11-data_003f"></a>
You can either type the data name directly (e.g MotionNotify) or you
can use the
print-xxx-name options.
</p><ul>
<li> <code>--print-data-name</code>
</li><li> <code>--print-event-name</code>
</li><li> <code>--print-error-name</code>
</li><li> <code>--print-reply-name</code>
</li><li> <code>--print-request-name</code>
</li></ul>
</dd>
<dt> ‘<samp>When I replay to another display the characters are not correct?</samp>’</dt>
<dd><a name="index-replay-to-another-display-the-characters-are-not-correct"></a>
<p>Make sure you use the same keyboard mapping.
<br>
A typical example:
<br>
<br>
Record local host using Xnee:
<br>
<code>cnee --record --out-file recorded_on_local.xnl </code>
<br>
<br>
Store remote keymap:
<br>
<code>xmodmap -pke -display remote:0 > remote.map </code>
<br>
<br>
Store local keymap:
<br>
<code>xmodmap -pke > local.map </code>
<br>
<br>
Copy local keymap to remote host:
<br>
<code>cat local.map | xmodmap -display remote:0 - </code>
<br>
<br>
Replay previously recorded session:
<br>
<code>cnee --replay --file recorded_on_local.xnl --display remote:0 </code>
<br>
<br>
Copy the original remote keymap to remote host:
<br>
<code>cat remote.map | xmodmap -display remote:0 - </code>
<br>
<br>
</p>
</dd>
<dt> ‘<samp>When starting Xnee I am informed that I am missing the RECORD extension</samp>’</dt>
<dd><a name="index-missing-RECORD-extension"></a>
<p>Your X server doesn’t have the RECORD extension either loaded or compiled. To solve this you have to, depending on what Xserver you have do the following:
</p>
</dd>
<dt> ‘<samp>Can Xnee record more than one display?</samp>’</dt>
<dd><a name="index-can-Xnee-record-more-than-one-display"></a>
<p>No, we used to consider adding the functionality but have no plans to
implement it anymore.
</p>
</dd>
<dt> ‘<samp>When starting Xnee I am informed that I am missing the RECORD extension</samp>’</dt>
<dd><a name="index-missing-RECORD-extension-1"></a>
<p>Your X server doesn’t have the RECORD extension either loaded or compiled. To solve this you have to, depending on what Xserver you have do the following:
</p>
<ul>
<li> XFree86 4.0 and higher
Make sure that the RECORD extension is loaded. This is done by letting the Module section in the X config file (e.g /etc/X11/XF86Config-4) look something like:
<p><code>Section "Module"</code><br>
<code>Load "dbe" # Double-buffering</code><br>
<code>Load "GLcore" # OpenGL support</code><br>
<code>Load "dri" # Direct rendering infrastructure</code><br>
<code>Load "glx" # OpenGL X protocol interface</code><br>
<code>Load "extmod" # Misc. required extensions</code><br>
<code>Load "v4l" # Video4Linux</code><br>
<code># Load "pex5" # PHIGS for X 3D environment (obsolete)</code><br>
<code>Load "record" # X event recorder</code><br>
<code># Load "xie" # X Image Extension (obsolete)</code><br>
<code># You only need the following two modules if you do not use xfs.</code><br>
<code># Load "freetype" # TrueType font handler</code><br>
<code># Load "type1" # Adobe Type 1 font handler</code><br>
EndSection
</p>
<p>The important load directive (in this case) is the following line<br>
<code>Load "record" # X event recorder</code><br>
</p>
</li><li> X.org, XFree86 (3.3 and lower) or any other Xserver
Recompile and reinstall the Xserver and make sure that RECORD extension
is built into the Xserver. Please look at the documentation from your
Xserver "vendor" on how to do that.
</li></ul>
</dd>
<dt> ‘<samp>How do I build VNC so that I can use Xnee together with it?</samp>’</dt>
<dd><a name="index-Build-VNC-to-be-used-with-Xnee"></a>
<br>
<p>Download vnc source from:
<br>
<a href="http://www.uk.research.att.com/vnc/xvnchistory.html">http://www.uk.research.att.com/vnc/xvnchistory.html</a>
<br>
<br>
In the file <code>Xvnc/config/cf/vnc.def</code> change NO on the following
items to YES as below:
<br>
<code>#define BuildRECORD YES</code>
<br>
<code>#define BuildRECORDlib YES</code>
<br>
<br>
Download the Xfree86 distribution from <a href="http://www.xfree86.org">http://www.xfree86.org</a>.
Specifically, the following dir,
(currently in the file <code>X430src-3.tgz file</code> ):
<br>
<code>tar zxvf \</code>
<br>
<code>X430src-3.tgz </code>
<br>
<code>xc/programs/Xserver/record/</code>
<br>
<code>xc/programs/Xserver/record/Imakefile</code>
<br>
<code>xc/programs/Xserver/record/record.c</code>
<br>
<code>xc/programs/Xserver/record/recordmod.c</code>
<br>
<code>xc/programs/Xserver/record/set.c</code>
<br>
<code>xc/programs/Xserver/record/set.h</code>
<br>
<code>xc/programs/Xserver/record/module/</code>
<br>
<code>xc/programs/Xserver/record/module/Imakefile</code>
<br>
<code>cp -rf \</code>
<br>
<code>xc/programs/Xserver/record \</code>
<br>
<code>vnc_unixsrc/Xvnc/programs/Xserver</code>
<br>
<code>cd libvncauth/</code>
<code>xmkmf</code>
<code>make all</code>
<br>
<code>cd Xvnc</code>
<code>make World |& tee LOG</code>
<br>
<br>
Verify the build by running <code>xdpyinfo</code> in an xterm in the vncserver
and verify that RECORD and XTEST extensions are loaded.
</p>
</dd>
<dt> ‘<samp>How do I ensure that the mouse, during replay, is at the same position (x,y) as when recorded?</samp>’</dt>
<dd><p>Use the <code>--store-mouse-pos</code> option.
This will cause Xnee to store the mouse position before starting to record. This position will be used to set the start position before replaying of recorded data starts.
</p>
</dd>
<dt> ‘<samp>How do I ensure that the same window is focused as when recorded?</samp>’</dt>
<dd><p>It’s simple, just make sure that you record the window getting focus.
</p>
</dd>
<dt> ‘<samp>The window pops up at different positions when replaying, can Xnee handle that?</samp>’</dt>
<dd><p>Yes, use the <code>--recall-window-position</code> option when
replaying (with cnee). This makes cnee try yo reposition the window as
it was positioned when recording the session.
</p>
</dd>
<dt> ‘<samp>Xnee seems to mess up my entire session after replaying a sessions which was interupted by Control-C?</samp>’</dt>
<dd><p>Xnee records the KeyPress belonging to Control. After that the system
sends Xnee a signal which makes Xnee stop recording. So you end up
having a Control KeyPress recorded, with no coresponding
KeyRelease. To solve the screwed up session, press Control (which
generates a KeyPress and the wanted KeyRelease). If you want to keep
your recorded session and not want this to happen again, remove the
last line in the recorded file starting with <code>2,</code>.
</p>
<p>A better way to interrupt Xnee is to use the stop key option, e.g in
cnee <code>--stop-key F1</code>. This prevents the above situation.
</p>
</dd>
<dt> ‘<samp>Autorepeat is turned off by Xnee, how do I turn it on again?</samp>’</dt>
<dd><p><code>xset r on</code>
</p>
</dd>
</dl>
<hr size="6">
<a name="Copying-This-Manual"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#FAQ" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#GNU-Free-Documentation-License" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#FAQ" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Copying-This-Manual-1"></a>
<h1 class="appendix">A. Copying This Manual</h1>
<hr size="6">
<a name="GNU-Free-Documentation-License"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Copying-This-Manual" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Copying-This-Manual" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Copying-This-Manual" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="appendixsec">A.1 GNU Free Documentation License</h2>
<a name="index-FDL_002c-GNU-Free-Documentation-License"></a>
<p align="center"> Version 1.2, November 2002
</p>
<table><tr><td> </td><td><pre class="display">Copyright © 2000,2001,2002 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
</pre></td></tr></table>
<ol>
<li>
PREAMBLE
<p>The purpose of this License is to make a manual, textbook, or other
functional and useful document <em>free</em> in the sense of freedom: to
assure everyone the effective freedom to copy and redistribute it,
with or without modifying it, either commercially or noncommercially.
Secondarily, this License preserves for the author and publisher a way
to get credit for their work, while not being considered responsible
for modifications made by others.
</p>
<p>This License is a kind of “copyleft”, which means that derivative
works of the document must themselves be free in the same sense. It
complements the GNU General Public License, which is a copyleft
license designed for free software.
</p>
<p>We have designed this License in order to use it for manuals for free
software, because free software needs free documentation: a free
program should come with manuals providing the same freedoms that the
software does. But this License is not limited to software manuals;
it can be used for any textual work, regardless of subject matter or
whether it is published as a printed book. We recommend this License
principally for works whose purpose is instruction or reference.
</p>
</li><li>
APPLICABILITY AND DEFINITIONS
<p>This License applies to any manual or other work, in any medium, that
contains a notice placed by the copyright holder saying it can be
distributed under the terms of this License. Such a notice grants a
world-wide, royalty-free license, unlimited in duration, to use that
work under the conditions stated herein. The “Document”, below,
refers to any such manual or work. Any member of the public is a
licensee, and is addressed as “you”. You accept the license if you
copy, modify or distribute the work in a way requiring permission
under copyright law.
</p>
<p>A “Modified Version” of the Document means any work containing the
Document or a portion of it, either copied verbatim, or with
modifications and/or translated into another language.
</p>
<p>A “Secondary Section” is a named appendix or a front-matter section
of the Document that deals exclusively with the relationship of the
publishers or authors of the Document to the Document’s overall
subject (or to related matters) and contains nothing that could fall
directly within that overall subject. (Thus, if the Document is in
part a textbook of mathematics, a Secondary Section may not explain
any mathematics.) The relationship could be a matter of historical
connection with the subject or with related matters, or of legal,
commercial, philosophical, ethical or political position regarding
them.
</p>
<p>The “Invariant Sections” are certain Secondary Sections whose titles
are designated, as being those of Invariant Sections, in the notice
that says that the Document is released under this License. If a
section does not fit the above definition of Secondary then it is not
allowed to be designated as Invariant. The Document may contain zero
Invariant Sections. If the Document does not identify any Invariant
Sections then there are none.
</p>
<p>The “Cover Texts” are certain short passages of text that are listed,
as Front-Cover Texts or Back-Cover Texts, in the notice that says that
the Document is released under this License. A Front-Cover Text may
be at most 5 words, and a Back-Cover Text may be at most 25 words.
</p>
<p>A “Transparent” copy of the Document means a machine-readable copy,
represented in a format whose specification is available to the
general public, that is suitable for revising the document
straightforwardly with generic text editors or (for images composed of
pixels) generic paint programs or (for drawings) some widely available
drawing editor, and that is suitable for input to text formatters or
for automatic translation to a variety of formats suitable for input
to text formatters. A copy made in an otherwise Transparent file
format whose markup, or absence of markup, has been arranged to thwart
or discourage subsequent modification by readers is not Transparent.
An image format is not Transparent if used for any substantial amount
of text. A copy that is not “Transparent” is called “Opaque”.
</p>
<p>Examples of suitable formats for Transparent copies include plain
<small>ASCII</small> without markup, Texinfo input format, LaTeX input
format, <acronym>SGML</acronym> or <acronym>XML</acronym> using a publicly available
<acronym>DTD</acronym>, and standard-conforming simple <acronym>HTML</acronym>,
PostScript or <acronym>PDF</acronym> designed for human modification. Examples
of transparent image formats include <acronym>PNG</acronym>, <acronym>XCF</acronym> and
<acronym>JPG</acronym>. Opaque formats include proprietary formats that can be
read and edited only by proprietary word processors, <acronym>SGML</acronym> or
<acronym>XML</acronym> for which the <acronym>DTD</acronym> and/or processing tools are
not generally available, and the machine-generated <acronym>HTML</acronym>,
PostScript or <acronym>PDF</acronym> produced by some word processors for
output purposes only.
</p>
<p>The “Title Page” means, for a printed book, the title page itself,
plus such following pages as are needed to hold, legibly, the material
this License requires to appear in the title page. For works in
formats which do not have any title page as such, “Title Page” means
the text near the most prominent appearance of the work’s title,
preceding the beginning of the body of the text.
</p>
<p>A section “Entitled XYZ” means a named subunit of the Document whose
title either is precisely XYZ or contains XYZ in parentheses following
text that translates XYZ in another language. (Here XYZ stands for a
specific section name mentioned below, such as “Acknowledgements”,
“Dedications”, “Endorsements”, or “History”.) To “Preserve the Title”
of such a section when you modify the Document means that it remains a
section “Entitled XYZ” according to this definition.
</p>
<p>The Document may include Warranty Disclaimers next to the notice which
states that this License applies to the Document. These Warranty
Disclaimers are considered to be included by reference in this
License, but only as regards disclaiming warranties: any other
implication that these Warranty Disclaimers may have is void and has
no effect on the meaning of this License.
</p>
</li><li>
VERBATIM COPYING
<p>You may copy and distribute the Document in any medium, either
commercially or noncommercially, provided that this License, the
copyright notices, and the license notice saying this License applies
to the Document are reproduced in all copies, and that you add no other
conditions whatsoever to those of this License. You may not use
technical measures to obstruct or control the reading or further
copying of the copies you make or distribute. However, you may accept
compensation in exchange for copies. If you distribute a large enough
number of copies you must also follow the conditions in section 3.
</p>
<p>You may also lend copies, under the same conditions stated above, and
you may publicly display copies.
</p>
</li><li>
COPYING IN QUANTITY
<p>If you publish printed copies (or copies in media that commonly have
printed covers) of the Document, numbering more than 100, and the
Document’s license notice requires Cover Texts, you must enclose the
copies in covers that carry, clearly and legibly, all these Cover
Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
the back cover. Both covers must also clearly and legibly identify
you as the publisher of these copies. The front cover must present
the full title with all words of the title equally prominent and
visible. You may add other material on the covers in addition.
Copying with changes limited to the covers, as long as they preserve
the title of the Document and satisfy these conditions, can be treated
as verbatim copying in other respects.
</p>
<p>If the required texts for either cover are too voluminous to fit
legibly, you should put the first ones listed (as many as fit
reasonably) on the actual cover, and continue the rest onto adjacent
pages.
</p>
<p>If you publish or distribute Opaque copies of the Document numbering
more than 100, you must either include a machine-readable Transparent
copy along with each Opaque copy, or state in or with each Opaque copy
a computer-network location from which the general network-using
public has access to download using public-standard network protocols
a complete Transparent copy of the Document, free of added material.
If you use the latter option, you must take reasonably prudent steps,
when you begin distribution of Opaque copies in quantity, to ensure
that this Transparent copy will remain thus accessible at the stated
location until at least one year after the last time you distribute an
Opaque copy (directly or through your agents or retailers) of that
edition to the public.
</p>
<p>It is requested, but not required, that you contact the authors of the
Document well before redistributing any large number of copies, to give
them a chance to provide you with an updated version of the Document.
</p>
</li><li>
MODIFICATIONS
<p>You may copy and distribute a Modified Version of the Document under
the conditions of sections 2 and 3 above, provided that you release
the Modified Version under precisely this License, with the Modified
Version filling the role of the Document, thus licensing distribution
and modification of the Modified Version to whoever possesses a copy
of it. In addition, you must do these things in the Modified Version:
</p>
<ol>
<li>
Use in the Title Page (and on the covers, if any) a title distinct
from that of the Document, and from those of previous versions
(which should, if there were any, be listed in the History section
of the Document). You may use the same title as a previous version
if the original publisher of that version gives permission.
</li><li>
List on the Title Page, as authors, one or more persons or entities
responsible for authorship of the modifications in the Modified
Version, together with at least five of the principal authors of the
Document (all of its principal authors, if it has fewer than five),
unless they release you from this requirement.
</li><li>
State on the Title page the name of the publisher of the
Modified Version, as the publisher.
</li><li>
Preserve all the copyright notices of the Document.
</li><li>
Add an appropriate copyright notice for your modifications
adjacent to the other copyright notices.
</li><li>
Include, immediately after the copyright notices, a license notice
giving the public permission to use the Modified Version under the
terms of this License, in the form shown in the Addendum below.
</li><li>
Preserve in that license notice the full lists of Invariant Sections
and required Cover Texts given in the Document’s license notice.
</li><li>
Include an unaltered copy of this License.
</li><li>
Preserve the section Entitled “History”, Preserve its Title, and add
to it an item stating at least the title, year, new authors, and
publisher of the Modified Version as given on the Title Page. If
there is no section Entitled “History” in the Document, create one
stating the title, year, authors, and publisher of the Document as
given on its Title Page, then add an item describing the Modified
Version as stated in the previous sentence.
</li><li>
Preserve the network location, if any, given in the Document for
public access to a Transparent copy of the Document, and likewise
the network locations given in the Document for previous versions
it was based on. These may be placed in the “History” section.
You may omit a network location for a work that was published at
least four years before the Document itself, or if the original
publisher of the version it refers to gives permission.
</li><li>
For any section Entitled “Acknowledgements” or “Dedications”, Preserve
the Title of the section, and preserve in the section all the
substance and tone of each of the contributor acknowledgements and/or
dedications given therein.
</li><li>
Preserve all the Invariant Sections of the Document,
unaltered in their text and in their titles. Section numbers
or the equivalent are not considered part of the section titles.
</li><li>
Delete any section Entitled “Endorsements”. Such a section
may not be included in the Modified Version.
</li><li>
Do not retitle any existing section to be Entitled “Endorsements” or
to conflict in title with any Invariant Section.
</li><li>
Preserve any Warranty Disclaimers.
</li></ol>
<p>If the Modified Version includes new front-matter sections or
appendices that qualify as Secondary Sections and contain no material
copied from the Document, you may at your option designate some or all
of these sections as invariant. To do this, add their titles to the
list of Invariant Sections in the Modified Version’s license notice.
These titles must be distinct from any other section titles.
</p>
<p>You may add a section Entitled “Endorsements”, provided it contains
nothing but endorsements of your Modified Version by various
parties—for example, statements of peer review or that the text has
been approved by an organization as the authoritative definition of a
standard.
</p>
<p>You may add a passage of up to five words as a Front-Cover Text, and a
passage of up to 25 words as a Back-Cover Text, to the end of the list
of Cover Texts in the Modified Version. Only one passage of
Front-Cover Text and one of Back-Cover Text may be added by (or
through arrangements made by) any one entity. If the Document already
includes a cover text for the same cover, previously added by you or
by arrangement made by the same entity you are acting on behalf of,
you may not add another; but you may replace the old one, on explicit
permission from the previous publisher that added the old one.
</p>
<p>The author(s) and publisher(s) of the Document do not by this License
give permission to use their names for publicity for or to assert or
imply endorsement of any Modified Version.
</p>
</li><li>
COMBINING DOCUMENTS
<p>You may combine the Document with other documents released under this
License, under the terms defined in section 4 above for modified
versions, provided that you include in the combination all of the
Invariant Sections of all of the original documents, unmodified, and
list them all as Invariant Sections of your combined work in its
license notice, and that you preserve all their Warranty Disclaimers.
</p>
<p>The combined work need only contain one copy of this License, and
multiple identical Invariant Sections may be replaced with a single
copy. If there are multiple Invariant Sections with the same name but
different contents, make the title of each such section unique by
adding at the end of it, in parentheses, the name of the original
author or publisher of that section if known, or else a unique number.
Make the same adjustment to the section titles in the list of
Invariant Sections in the license notice of the combined work.
</p>
<p>In the combination, you must combine any sections Entitled “History”
in the various original documents, forming one section Entitled
“History”; likewise combine any sections Entitled “Acknowledgements”,
and any sections Entitled “Dedications”. You must delete all
sections Entitled “Endorsements.”
</p>
</li><li>
COLLECTIONS OF DOCUMENTS
<p>You may make a collection consisting of the Document and other documents
released under this License, and replace the individual copies of this
License in the various documents with a single copy that is included in
the collection, provided that you follow the rules of this License for
verbatim copying of each of the documents in all other respects.
</p>
<p>You may extract a single document from such a collection, and distribute
it individually under this License, provided you insert a copy of this
License into the extracted document, and follow this License in all
other respects regarding verbatim copying of that document.
</p>
</li><li>
AGGREGATION WITH INDEPENDENT WORKS
<p>A compilation of the Document or its derivatives with other separate
and independent documents or works, in or on a volume of a storage or
distribution medium, is called an “aggregate” if the copyright
resulting from the compilation is not used to limit the legal rights
of the compilation’s users beyond what the individual works permit.
When the Document is included an aggregate, this License does not
apply to the other works in the aggregate which are not themselves
derivative works of the Document.
</p>
<p>If the Cover Text requirement of section 3 is applicable to these
copies of the Document, then if the Document is less than one half of
the entire aggregate, the Document’s Cover Texts may be placed on
covers that bracket the Document within the aggregate, or the
electronic equivalent of covers if the Document is in electronic form.
Otherwise they must appear on printed covers that bracket the whole
aggregate.
</p>
</li><li>
TRANSLATION
<p>Translation is considered a kind of modification, so you may
distribute translations of the Document under the terms of section 4.
Replacing Invariant Sections with translations requires special
permission from their copyright holders, but you may include
translations of some or all Invariant Sections in addition to the
original versions of these Invariant Sections. You may include a
translation of this License, and all the license notices in the
Document, and any Warrany Disclaimers, provided that you also include
the original English version of this License and the original versions
of those notices and disclaimers. In case of a disagreement between
the translation and the original version of this License or a notice
or disclaimer, the original version will prevail.
</p>
<p>If a section in the Document is Entitled “Acknowledgements”,
“Dedications”, or “History”, the requirement (section 4) to Preserve
its Title (section 1) will typically require changing the actual
title.
</p>
</li><li>
TERMINATION
<p>You may not copy, modify, sublicense, or distribute the Document except
as expressly provided for under this License. Any other attempt to
copy, modify, sublicense or distribute the Document is void, and will
automatically terminate your rights under this License. However,
parties who have received copies, or rights, from you under this
License will not have their licenses terminated so long as such
parties remain in full compliance.
</p>
</li><li>
FUTURE REVISIONS OF THIS LICENSE
<p>The Free Software Foundation may publish new, revised versions
of the GNU Free Documentation License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns. See
<a href="http://www.gnu.org/copyleft/">http://www.gnu.org/copyleft/</a>.
</p>
<p>Each version of the License is given a distinguishing version number.
If the Document specifies that a particular numbered version of this
License “or any later version” applies to it, you have the option of
following the terms and conditions either of that specified version or
of any later version that has been published (not as a draft) by the
Free Software Foundation. If the Document does not specify a version
number of this License, you may choose any version ever published (not
as a draft) by the Free Software Foundation.
</p></li></ol>
<hr size="6">
<a name="Index"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#GNU-Free-Documentation-License" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[ > ]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Copying-This-Manual" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[ >> ]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Index-1"></a>
<h1 class="chapter">B. Index</h1>
<table><tr><th valign="top">Jump to: </th><td><a href="#Index-1_cp_letter-B" class="summary-letter"><b>B</b></a>
<a href="#Index-1_cp_letter-C" class="summary-letter"><b>C</b></a>
<a href="#Index-1_cp_letter-D" class="summary-letter"><b>D</b></a>
<a href="#Index-1_cp_letter-E" class="summary-letter"><b>E</b></a>
<a href="#Index-1_cp_letter-F" class="summary-letter"><b>F</b></a>
<a href="#Index-1_cp_letter-G" class="summary-letter"><b>G</b></a>
<a href="#Index-1_cp_letter-H" class="summary-letter"><b>H</b></a>
<a href="#Index-1_cp_letter-I" class="summary-letter"><b>I</b></a>
<a href="#Index-1_cp_letter-K" class="summary-letter"><b>K</b></a>
<a href="#Index-1_cp_letter-L" class="summary-letter"><b>L</b></a>
<a href="#Index-1_cp_letter-M" class="summary-letter"><b>M</b></a>
<a href="#Index-1_cp_letter-P" class="summary-letter"><b>P</b></a>
<a href="#Index-1_cp_letter-Q" class="summary-letter"><b>Q</b></a>
<a href="#Index-1_cp_letter-R" class="summary-letter"><b>R</b></a>
<a href="#Index-1_cp_letter-S" class="summary-letter"><b>S</b></a>
<a href="#Index-1_cp_letter-U" class="summary-letter"><b>U</b></a>
<a href="#Index-1_cp_letter-W" class="summary-letter"><b>W</b></a>
<a href="#Index-1_cp_letter-X" class="summary-letter"><b>X</b></a>
</td></tr></table>
<table border="0" class="index-cp">
<tr><td></td><th align="left">Index Entry</th><th align="left"> Section</th></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Index-1_cp_letter-B">B</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-background">background</a></td><td valign="top"><a href="#Background">1.3 Background</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Build-VNC-to-be-used-with-Xnee">Build VNC to be used with Xnee</a></td><td valign="top"><a href="#FAQ">10. FAQ</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Index-1_cp_letter-C">C</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-can-Xnee-record-more-than-one-display">can Xnee record more than one display</a></td><td valign="top"><a href="#FAQ">10. FAQ</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-command-line-syntax">command line syntax</a></td><td valign="top"><a href="#Command-line-syntax">3.8.1 Command line syntax</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Comment-directives">Comment directives</a></td><td valign="top"><a href="#Comment">7.4.1 Comment</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Create-a-project-file">Create a project file</a></td><td valign="top"><a href="#Create-a-project-file">7.1.1 Create a project file</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Index-1_cp_letter-D">D</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Define-a-simple-macro">Define a simple macro</a></td><td valign="top"><a href="#Define-a-simple-macro">5.6.1 Define a simple macro</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Define-another-simple-macro">Define another simple macro</a></td><td valign="top"><a href="#Define-another-simple-macro">5.6.2 Define another simple macro</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-development-requirements">development requirements</a></td><td valign="top"><a href="#Development-requirements">9.2 Development requirements</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Distribute-the-replaying-of-mouse-motions">Distribute the replaying of mouse motions</a></td><td valign="top"><a href="#Distribute-the-replaying-of-mouse-motions">5.4.2 Distribute the replaying of mouse motions</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Distribute-the-retyping-of-a-file">Distribute the retyping of a file</a></td><td valign="top"><a href="#Distribute-the-retyping-of-a-file">5.4.3 Distribute the retyping of a file</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Distribute-your-mouse-motions">Distribute your mouse motions</a></td><td valign="top"><a href="#Distribute-your-mouse-motions">5.4.1 Distribute your mouse motions</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-distributing">distributing</a></td><td valign="top"><a href="#Distribution">3.2.4 Distribution</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Index-1_cp_letter-E">E</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Example-Xnee-Session-files">Example Xnee Session files</a></td><td valign="top"><a href="#Example-Xnee-Session-files">2.1.7 Example Xnee Session files</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Exec-directive">Exec directive</a></td><td valign="top"><a href="#Exec">7.4.6 Exec</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Index-1_cp_letter-F">F</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-FDL_002c-GNU-Free-Documentation-License">FDL, GNU Free Documentation License</a></td><td valign="top"><a href="#GNU-Free-Documentation-License">A.1 GNU Free Documentation License</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-features">features</a></td><td valign="top"><a href="#Xnee-features">1.2 Xnee features</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Functional-overview">Functional overview</a></td><td valign="top"><a href="#Functional-overview-2">3.1 Functional overview</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Index-1_cp_letter-G">G</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Getting-started">Getting started</a></td><td valign="top"><a href="#Getting-started-2">2.1 Getting started</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-GUI-frontend-for-Xnee">GUI frontend for Xnee</a></td><td valign="top"><a href="#FAQ">10. FAQ</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Index-1_cp_letter-H">H</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-how-to-synchronise">how to synchronise</a></td><td valign="top"><a href="#How-to-synchronise">8.1.2 How to synchronise</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Index-1_cp_letter-I">I</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Insert-marks-Xnee-with-key-combination">Insert marks Xnee with key combination</a></td><td valign="top"><a href="#Insert-marks-Xnee-with-key-combination">3.9.7 Insert marks Xnee with key combination</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Interupting-xnee">Interupting xnee</a></td><td valign="top"><a href="#Interupting-Xnee">3.9 Interupting Xnee</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Index-1_cp_letter-K">K</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-key">key</a></td><td valign="top"><a href="#modifier-and-key">3.9.1 modifier and key</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Index-1_cp_letter-L">L</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-license">license</a></td><td valign="top"><a href="#FAQ">10. FAQ</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-limit-the-data">limit the data</a></td><td valign="top"><a href="#Limit-the-data-to-record">3.9.10 Limit the data to record</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-limit-the-events">limit the events</a></td><td valign="top"><a href="#Limit-the-events-to-record">3.9.9 Limit the events to record</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-limit-the-events-1">limit the events</a></td><td valign="top"><a href="#Limit-the-time-to-record">3.9.11 Limit the time to record</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Index-1_cp_letter-M">M</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Mark-directive">Mark directive</a></td><td valign="top"><a href="#Mark">7.4.5 Mark</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-missing-RECORD-extension">missing RECORD extension</a></td><td valign="top"><a href="#FAQ">10. FAQ</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-missing-RECORD-extension-1">missing RECORD extension</a></td><td valign="top"><a href="#FAQ">10. FAQ</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-modes">modes</a></td><td valign="top"><a href="#Modes">3.2 Modes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-modifier">modifier</a></td><td valign="top"><a href="#modifier-and-key">3.9.1 modifier and key</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Index-1_cp_letter-P">P</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Pause-Xnee-with-key-combination">Pause Xnee with key combination</a></td><td valign="top"><a href="#Pause-Xnee-with-key-combination">3.9.5 Pause Xnee with key combination</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Pause-Xnee-with-key-combination-1">Pause Xnee with key combination</a></td><td valign="top"><a href="#Pause-Xnee-with-key-combination-1">3.9.6 Pause Xnee with key combination</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Pausing-and-resuming-Xnee-with-key">Pausing and resuming Xnee with key</a></td><td valign="top"><a href="#Pausing-and-resuming-Xnee-with-key">5.5.2 Pausing and resuming Xnee with key</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-plugins">plugins</a></td><td valign="top"><a href="#Xnee-plugins">3.10 Xnee plugins</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Project-file">Project file</a></td><td valign="top"><a href="#Project-file-1">7.1 Project file</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Project-information-directive">Project information directive</a></td><td valign="top"><a href="#Project-information">7.4.7 Project information</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Index-1_cp_letter-Q">Q</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-questions-is-sent-where_003f">questions is sent where?</a></td><td valign="top"><a href="#FAQ">10. FAQ</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Index-1_cp_letter-R">R</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-ranges">ranges</a></td><td valign="top"><a href="#Ranges">3.3 Ranges</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Record-a-gnumeric-session">Record a gnumeric session</a></td><td valign="top"><a href="#Record-a-gnumeric-session">5.1.4 Record a gnumeric session</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Record-a-gnumeric-session-with-synchronisation-data">Record a gnumeric session with synchronisation data</a></td><td valign="top"><a href="#Record-a-gnumeric-session-with-synchronisation-data">5.1.5 Record a gnumeric session with synchronisation data</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Record-another-display-than-the-default">Record another display than the default</a></td><td valign="top"><a href="#Record-another-display-than-the-default">5.7.7 Record another display than the default</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Record-keyboard">Record keyboard</a></td><td valign="top"><a href="#Record-keyboard">5.1.2 Record keyboard</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Record-keyboard-and-mouse">Record keyboard and mouse</a></td><td valign="top"><a href="#Record-keyboard-and-mouse">5.1.3 Record keyboard and mouse</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Record-mouse-motions">Record mouse motions</a></td><td valign="top"><a href="#Record-mouse-motions">5.1.1 Record mouse motions</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-recording">recording</a></td><td valign="top"><a href="#Record">3.2.1 Record</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Replay-a-gnumeric-session">Replay a gnumeric session</a></td><td valign="top"><a href="#Replay-a-gnumeric-session">5.2.6 Replay a gnumeric session</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Replay-a-gnumeric-session-with-synchronisation-data">Replay a gnumeric session with synchronisation data</a></td><td valign="top"><a href="#Replay-a-gnumeric-session-with-synchronisation-data">5.2.7 Replay a gnumeric session with synchronisation data</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Replay-a-gnumeric-session-with-synchronisation-data-setting-threshold">Replay a gnumeric session with synchronisation data setting threshold</a></td><td valign="top"><a href="#Replay-a-gnumeric-session-with-synchronisation-data-setting-threshold">5.2.8 Replay a gnumeric session with synchronisation data setting threshold</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Replay-directive">Replay directive</a></td><td valign="top"><a href="#Replay-1">7.4.3 Replay</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Replay-keyboard-actions">Replay keyboard actions</a></td><td valign="top"><a href="#Replay-keyboard-actions">5.2.4 Replay keyboard actions</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Replay-keyboard-and-mouse">Replay keyboard and mouse</a></td><td valign="top"><a href="#Replay-keyboard-and-mouse">5.2.5 Replay keyboard and mouse</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-replay-mouse-motions">replay mouse motions</a></td><td valign="top"><a href="#Replay-mouse-motions">5.2.1 Replay mouse motions</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Replay-to-another-display-than-the-default">Replay to another display than the default</a></td><td valign="top"><a href="#Replay-to-another-display-than-the-default">5.7.8 Replay to another display than the default</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-replay-to-another-display-the-characters-are-not-correct">replay to another display the characters are not correct</a></td><td valign="top"><a href="#FAQ">10. FAQ</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-replay-using-double-speed">replay using double speed</a></td><td valign="top"><a href="#Replay-mouse-motions-using-with-double-speed">5.2.3 Replay mouse motions using with double speed</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-replay-using-half-speed">replay using half speed</a></td><td valign="top"><a href="#Replay-mouse-motions-using-with-half-speed">5.2.2 Replay mouse motions using with half speed</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-replaying">replaying</a></td><td valign="top"><a href="#Replay">3.2.2 Replay</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Report-bugs_003f">Report bugs?</a></td><td valign="top"><a href="#FAQ">10. FAQ</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Reporting-pnee-bugs">Reporting pnee bugs</a></td><td valign="top"><a href="#Reporting-pnee-bugs">6.3.1 Reporting pnee bugs</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-requirements">requirements</a></td><td valign="top"><a href="#Requirements">9. Xnee Requirements</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-retype">retype</a></td><td valign="top"><a href="#Retype">3.2.3 Retype</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Retype-a-file">Retype a file</a></td><td valign="top"><a href="#Retype-a-file">5.3.2 Retype a file</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Retype-the-help-printout">Retype the help printout</a></td><td valign="top"><a href="#Retype-the-help-printout">5.3.1 Retype the help printout</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-runtime-requirements">runtime requirements</a></td><td valign="top"><a href="#Runtime-requirements">9.1 Runtime requirements</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Index-1_cp_letter-S">S</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Script-replay-data">Script replay data</a></td><td valign="top"><a href="#Script-replay-data">7.4.4 Script replay data</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Session-file">Session file</a></td><td valign="top"><a href="#Xnee-Session-file">7.2 Xnee Session file</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Settings">Settings</a></td><td valign="top"><a href="#Settings">7.4.2 Settings</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Shell-scripts-using-Xnee">Shell scripts using Xnee</a></td><td valign="top"><a href="#Shell-scripts-using-Xnee">5.8 Shell scripts using Xnee</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-SIGTERM">SIGTERM</a></td><td valign="top"><a href="#sending-a-SIGTERM-signal">3.9.3 sending a SIGTERM signal</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-SIGTERM-1">SIGTERM</a></td><td valign="top"><a href="#Send-SIGTERM-to-Xnee">3.9.12 Send SIGTERM to Xnee</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Stop-Xnee-with-key">Stop Xnee with key</a></td><td valign="top"><a href="#Stop-Xnee-with-key">5.5.1 Stop Xnee with key</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Stop-Xnee-with-key-combination">Stop Xnee with key combination</a></td><td valign="top"><a href="#Stop-Xnee-with-key-combination">3.9.4 Stop Xnee with key combination</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Synchronisation">Synchronisation</a></td><td valign="top"><a href="#Synchronisation">8.1 Synchronisation</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Index-1_cp_letter-U">U</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Using-a-differet-screen-resolution">Using a differet screen resolution</a></td><td valign="top"><a href="#Using-a-differet-screen-resolution">5.7.3 Using a differet screen resolution</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Using-a-offset-when-replaying">Using a offset when replaying</a></td><td valign="top"><a href="#Using-a-offset-when-replaying">5.7.4 Using a offset when replaying</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Using-a-window-position-recall">Using a window position recall</a></td><td valign="top"><a href="#Using-a-window-position-recall">5.7.5 Using a window position recall</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Using-human-readable-printouts">Using human readable printouts</a></td><td valign="top"><a href="#Using-human-readable-printouts">5.7.2 Using human readable printouts</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Using-no-resolution-translation">Using no resolution translation</a></td><td valign="top"><a href="#Using-no-resolution-translation">5.7.6 Using no resolution translation</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Using-verbose-mode">Using verbose mode</a></td><td valign="top"><a href="#Using-verbose-mode">5.7.1 Using verbose mode</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Index-1_cp_letter-W">W</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-What-does-the-name-cnee-mean_003f">What does the name cnee mean?</a></td><td valign="top"><a href="#FAQ">10. FAQ</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-What-does-the-name-gnee-mean_003f">What does the name gnee mean?</a></td><td valign="top"><a href="#FAQ">10. FAQ</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-What-does-the-name-gnee-mean_003f-1">What does the name gnee mean?</a></td><td valign="top"><a href="#FAQ">10. FAQ</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-What-does-the-name-gnee-mean_003f-2">What does the name gnee mean?</a></td><td valign="top"><a href="#FAQ">10. FAQ</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-what-numbers-belong-to-X11-data_003f">what numbers belong to X11 data?</a></td><td valign="top"><a href="#FAQ">10. FAQ</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-why-name-it-Xnee">why name it Xnee</a></td><td valign="top"><a href="#FAQ">10. FAQ</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-why-synchronise">why synchronise</a></td><td valign="top"><a href="#Why-synchronise">8.1.1 Why synchronise</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Index-1_cp_letter-X">X</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Xnee-Internals">Xnee Internals</a></td><td valign="top"><a href="#Internals">8. Xnee Internals</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Xnee-Settings-Arguments">Xnee Settings Arguments</a></td><td valign="top"><a href="#Settings">7.4.2 Settings</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
</table>
<table><tr><th valign="top">Jump to: </th><td><a href="#Index-1_cp_letter-B" class="summary-letter"><b>B</b></a>
<a href="#Index-1_cp_letter-C" class="summary-letter"><b>C</b></a>
<a href="#Index-1_cp_letter-D" class="summary-letter"><b>D</b></a>
<a href="#Index-1_cp_letter-E" class="summary-letter"><b>E</b></a>
<a href="#Index-1_cp_letter-F" class="summary-letter"><b>F</b></a>
<a href="#Index-1_cp_letter-G" class="summary-letter"><b>G</b></a>
<a href="#Index-1_cp_letter-H" class="summary-letter"><b>H</b></a>
<a href="#Index-1_cp_letter-I" class="summary-letter"><b>I</b></a>
<a href="#Index-1_cp_letter-K" class="summary-letter"><b>K</b></a>
<a href="#Index-1_cp_letter-L" class="summary-letter"><b>L</b></a>
<a href="#Index-1_cp_letter-M" class="summary-letter"><b>M</b></a>
<a href="#Index-1_cp_letter-P" class="summary-letter"><b>P</b></a>
<a href="#Index-1_cp_letter-Q" class="summary-letter"><b>Q</b></a>
<a href="#Index-1_cp_letter-R" class="summary-letter"><b>R</b></a>
<a href="#Index-1_cp_letter-S" class="summary-letter"><b>S</b></a>
<a href="#Index-1_cp_letter-U" class="summary-letter"><b>U</b></a>
<a href="#Index-1_cp_letter-W" class="summary-letter"><b>W</b></a>
<a href="#Index-1_cp_letter-X" class="summary-letter"><b>X</b></a>
</td></tr></table>
<hr size="6">
<a name="SEC_Contents"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h1>Table of Contents</h1>
<div class="contents">
<ul class="toc">
<li><a name="toc-Summary-2" href="#Summary">1. Summary</a>
<ul class="toc">
<li><a name="toc-Summary-1" href="#Summary-1">1.1 Summary</a></li>
<li><a name="toc-Xnee-features" href="#Xnee-features">1.2 Xnee features</a></li>
<li><a name="toc-Background" href="#Background">1.3 Background</a></li>
</ul></li>
<li><a name="toc-Getting-started-1" href="#Getting-started">2. Getting started</a>
<ul class="toc">
<li><a name="toc-Getting-started-2" href="#Getting-started-2">2.1 Getting started</a>
<ul class="toc">
<li><a name="toc-Simple-replay" href="#Simple-replay">2.1.1 Simple replay</a></li>
<li><a name="toc-Simple-recording-of-Key-presses" href="#Simple-recording-of-Key-presses">2.1.2 Simple recording of Key presses</a></li>
<li><a name="toc-Simple-replaying-of-your-recorded-file" href="#Simple-replaying-of-your-recorded-file">2.1.3 Simple replaying of your recorded file</a></li>
<li><a name="toc-Simple-recording-of-mouse-motions" href="#Simple-recording-of-mouse-motions">2.1.4 Simple recording of mouse motions</a></li>
<li><a name="toc-Simple-replaying-of-your-recorded-file-1" href="#Simple-replaying-of-your-recorded-file-1">2.1.5 Simple replaying of your recorded file</a></li>
<li><a name="toc-Simple-retyping-of-a-text-file" href="#Simple-retyping-of-a-text-file">2.1.6 Simple retyping of a text file</a></li>
<li><a name="toc-Example-Xnee-Session-files" href="#Example-Xnee-Session-files">2.1.7 Example Xnee Session files</a></li>
</ul>
</li>
</ul></li>
<li><a name="toc-Functional-overview-1" href="#Functional-overview">3. Functional overview</a>
<ul class="toc">
<li><a name="toc-Functional-overview-2" href="#Functional-overview-2">3.1 Functional overview</a></li>
<li><a name="toc-Modes" href="#Modes">3.2 Modes</a>
<ul class="toc">
<li><a name="toc-Record" href="#Record">3.2.1 Record</a></li>
<li><a name="toc-Replay" href="#Replay">3.2.2 Replay</a></li>
<li><a name="toc-Retype" href="#Retype">3.2.3 Retype</a></li>
<li><a name="toc-Distribution" href="#Distribution">3.2.4 Distribution</a></li>
</ul></li>
<li><a name="toc-Ranges" href="#Ranges">3.3 Ranges</a></li>
<li><a name="toc-First-and-last-motion-event" href="#First-and-last-motion-event">3.4 First and last motion event</a></li>
<li><a name="toc-Delay" href="#Delay">3.5 Delay</a></li>
<li><a name="toc-Verbose" href="#Verbose">3.6 Verbose</a></li>
<li><a name="toc-Human-printouts" href="#Human-printouts">3.7 Human printouts</a></li>
<li><a name="toc-Invoking-Xnee" href="#Invoking-Xnee">3.8 Invoking Xnee</a>
<ul class="toc">
<li><a name="toc-Command-line-syntax" href="#Command-line-syntax">3.8.1 Command line syntax</a></li>
<li><a name="toc-Project-file" href="#Project-file">3.8.2 Project file</a></li>
<li><a name="toc-Session-file" href="#Session-file">3.8.3 Session file</a></li>
</ul></li>
<li><a name="toc-Interupting-Xnee" href="#Interupting-Xnee">3.9 Interupting Xnee</a>
<ul class="toc">
<li><a name="toc-modifier-and-key" href="#modifier-and-key">3.9.1 modifier and key</a></li>
<li><a name="toc-limit-the-number-of-data-to-record" href="#limit-the-number-of-data-to-record">3.9.2 limit the number of data to record</a></li>
<li><a name="toc-sending-a-SIGTERM-signal" href="#sending-a-SIGTERM-signal">3.9.3 sending a SIGTERM signal</a></li>
<li><a name="toc-Stop-Xnee-with-key-combination" href="#Stop-Xnee-with-key-combination">3.9.4 Stop Xnee with key combination</a></li>
<li><a name="toc-Pause-Xnee-with-key-combination" href="#Pause-Xnee-with-key-combination">3.9.5 Pause Xnee with key combination</a></li>
<li><a name="toc-Pause-Xnee-with-key-combination-1" href="#Pause-Xnee-with-key-combination-1">3.9.6 Pause Xnee with key combination</a></li>
<li><a name="toc-Insert-marks-Xnee-with-key-combination" href="#Insert-marks-Xnee-with-key-combination">3.9.7 Insert marks Xnee with key combination</a></li>
<li><a name="toc-Limit-number-of-data-to-record" href="#Limit-number-of-data-to-record">3.9.8 Limit number of data to record</a></li>
<li><a name="toc-Limit-the-events-to-record" href="#Limit-the-events-to-record">3.9.9 Limit the events to record</a></li>
<li><a name="toc-Limit-the-data-to-record" href="#Limit-the-data-to-record">3.9.10 Limit the data to record</a></li>
<li><a name="toc-Limit-the-time-to-record" href="#Limit-the-time-to-record">3.9.11 Limit the time to record</a></li>
<li><a name="toc-Send-SIGTERM-to-Xnee" href="#Send-SIGTERM-to-Xnee">3.9.12 Send SIGTERM to Xnee</a></li>
</ul></li>
<li><a name="toc-Xnee-plugins" href="#Xnee-plugins">3.10 Xnee plugins</a></li>
</ul></li>
<li><a name="toc-Installation-1" href="#Installation">4. Installation</a>
<ul class="toc">
<li><a name="toc-Installation-from-source-with-the-configure-script" href="#Installation-from-source-with-the-configure-script">4.1 Installation from source with the configure script</a></li>
<li><a name="toc-Installation-from-source-with-default-Makefile" href="#Installation-from-source-with-default-Makefile">4.2 Installation from source with default Makefile</a></li>
<li><a name="toc-Installation-from-CVS" href="#Installation-from-CVS">4.3 Installation from CVS</a></li>
</ul></li>
<li><a name="toc-Examples-1" href="#Examples">5. Examples</a>
<ul class="toc">
<li><a name="toc-Recorder" href="#Recorder">5.1 Recorder</a>
<ul class="toc">
<li><a name="toc-Record-mouse-motions" href="#Record-mouse-motions">5.1.1 Record mouse motions</a></li>
<li><a name="toc-Record-keyboard" href="#Record-keyboard">5.1.2 Record keyboard</a></li>
<li><a name="toc-Record-keyboard-and-mouse" href="#Record-keyboard-and-mouse">5.1.3 Record keyboard and mouse</a></li>
<li><a name="toc-Record-a-gnumeric-session" href="#Record-a-gnumeric-session">5.1.4 Record a gnumeric session</a></li>
<li><a name="toc-Record-a-gnumeric-session-with-synchronisation-data" href="#Record-a-gnumeric-session-with-synchronisation-data">5.1.5 Record a gnumeric session with synchronisation data</a></li>
</ul></li>
<li><a name="toc-Replayer" href="#Replayer">5.2 Replayer</a>
<ul class="toc">
<li><a name="toc-Replay-mouse-motions" href="#Replay-mouse-motions">5.2.1 Replay mouse motions</a></li>
<li><a name="toc-Replay-mouse-motions-using-with-half-speed" href="#Replay-mouse-motions-using-with-half-speed">5.2.2 Replay mouse motions using with half speed</a></li>
<li><a name="toc-Replay-mouse-motions-using-with-double-speed" href="#Replay-mouse-motions-using-with-double-speed">5.2.3 Replay mouse motions using with double speed</a></li>
<li><a name="toc-Replay-keyboard-actions" href="#Replay-keyboard-actions">5.2.4 Replay keyboard actions</a></li>
<li><a name="toc-Replay-keyboard-and-mouse" href="#Replay-keyboard-and-mouse">5.2.5 Replay keyboard and mouse</a></li>
<li><a name="toc-Replay-a-gnumeric-session" href="#Replay-a-gnumeric-session">5.2.6 Replay a gnumeric session</a></li>
<li><a name="toc-Replay-a-gnumeric-session-with-synchronisation-data" href="#Replay-a-gnumeric-session-with-synchronisation-data">5.2.7 Replay a gnumeric session with synchronisation data</a></li>
<li><a name="toc-Replay-a-gnumeric-session-with-synchronisation-data-setting-threshold" href="#Replay-a-gnumeric-session-with-synchronisation-data-setting-threshold">5.2.8 Replay a gnumeric session with synchronisation data setting threshold</a></li>
</ul></li>
<li><a name="toc-Retyper" href="#Retyper">5.3 Retyper</a>
<ul class="toc">
<li><a name="toc-Retype-the-help-printout" href="#Retype-the-help-printout">5.3.1 Retype the help printout</a></li>
<li><a name="toc-Retype-a-file" href="#Retype-a-file">5.3.2 Retype a file</a></li>
</ul></li>
<li><a name="toc-Distributor" href="#Distributor">5.4 Distributor</a>
<ul class="toc">
<li><a name="toc-Distribute-your-mouse-motions" href="#Distribute-your-mouse-motions">5.4.1 Distribute your mouse motions</a></li>
<li><a name="toc-Distribute-the-replaying-of-mouse-motions" href="#Distribute-the-replaying-of-mouse-motions">5.4.2 Distribute the replaying of mouse motions</a></li>
<li><a name="toc-Distribute-the-retyping-of-a-file" href="#Distribute-the-retyping-of-a-file">5.4.3 Distribute the retyping of a file</a></li>
</ul></li>
<li><a name="toc-Key" href="#Key">5.5 Key</a>
<ul class="toc">
<li><a name="toc-Stop-Xnee-with-key" href="#Stop-Xnee-with-key">5.5.1 Stop Xnee with key</a></li>
<li><a name="toc-Pausing-and-resuming-Xnee-with-key" href="#Pausing-and-resuming-Xnee-with-key">5.5.2 Pausing and resuming Xnee with key</a></li>
</ul></li>
<li><a name="toc-Using-macro" href="#Using-macro">5.6 Using macro</a>
<ul class="toc">
<li><a name="toc-Define-a-simple-macro" href="#Define-a-simple-macro">5.6.1 Define a simple macro</a></li>
<li><a name="toc-Define-another-simple-macro" href="#Define-another-simple-macro">5.6.2 Define another simple macro</a></li>
</ul></li>
<li><a name="toc-Various-options" href="#Various-options">5.7 Various options</a>
<ul class="toc">
<li><a name="toc-Using-verbose-mode" href="#Using-verbose-mode">5.7.1 Using verbose mode</a></li>
<li><a name="toc-Using-human-readable-printouts" href="#Using-human-readable-printouts">5.7.2 Using human readable printouts</a></li>
<li><a name="toc-Using-a-differet-screen-resolution" href="#Using-a-differet-screen-resolution">5.7.3 Using a differet screen resolution</a></li>
<li><a name="toc-Using-a-offset-when-replaying" href="#Using-a-offset-when-replaying">5.7.4 Using a offset when replaying</a></li>
<li><a name="toc-Using-a-window-position-recall" href="#Using-a-window-position-recall">5.7.5 Using a window position recall</a></li>
<li><a name="toc-Using-no-resolution-translation" href="#Using-no-resolution-translation">5.7.6 Using no resolution translation</a></li>
<li><a name="toc-Record-another-display-than-the-default" href="#Record-another-display-than-the-default">5.7.7 Record another display than the default</a></li>
<li><a name="toc-Replay-to-another-display-than-the-default" href="#Replay-to-another-display-than-the-default">5.7.8 Replay to another display than the default</a></li>
</ul></li>
<li><a name="toc-Shell-scripts-using-Xnee" href="#Shell-scripts-using-Xnee">5.8 Shell scripts using Xnee</a></li>
</ul></li>
<li><a name="toc-Xnee-Programs" href="#Programs">6. Xnee Programs</a>
<ul class="toc">
<li><a name="toc-cnee-_002d-cnee_0027s-not-an-event-emulator" href="#cnee-_002d-cnee_0027s-not-an-event-emulator">6.1 cnee - cnee’s not an event emulator</a></li>
<li><a name="toc-gnee-_002d-gnee_0027s-not-an-emulator-either" href="#gnee-_002d-gnee_0027s-not-an-emulator-either">6.2 gnee - gnee’s not an emulator either</a></li>
<li><a name="toc-pnee-_002d-pnee_0027s-not-even-emulating" href="#pnee-_002d-pnee_0027s-not-even-emulating">6.3 pnee - pnee’s not even emulating</a>
<ul class="toc">
<li><a name="toc-Reporting-pnee-bugs" href="#Reporting-pnee-bugs">6.3.1 Reporting pnee bugs</a></li>
</ul>
</li>
</ul></li>
<li><a name="toc-File-types-and-format" href="#File-format">7. File types and format</a>
<ul class="toc">
<li><a name="toc-Project-file-1" href="#Project-file-1">7.1 Project file</a>
<ul class="toc">
<li><a name="toc-Create-a-project-file" href="#Create-a-project-file">7.1.1 Create a project file</a></li>
</ul></li>
<li><a name="toc-Xnee-Session-file" href="#Xnee-Session-file">7.2 Xnee Session file</a></li>
<li><a name="toc-Xnee-file-format" href="#Xnee-file-format">7.3 Xnee file format</a></li>
<li><a name="toc-Xnee-directives" href="#Xnee-directives">7.4 Xnee directives</a>
<ul class="toc">
<li><a name="toc-Comment" href="#Comment">7.4.1 Comment</a></li>
<li><a name="toc-Settings" href="#Settings">7.4.2 Settings</a></li>
<li><a name="toc-Replay-1" href="#Replay-1">7.4.3 Replay</a></li>
<li><a name="toc-Script-replay-data" href="#Script-replay-data">7.4.4 Script replay data</a></li>
<li><a name="toc-Mark" href="#Mark">7.4.5 Mark</a></li>
<li><a name="toc-Exec" href="#Exec">7.4.6 Exec</a></li>
<li><a name="toc-Project-information" href="#Project-information">7.4.7 Project information</a></li>
</ul>
</li>
</ul></li>
<li><a name="toc-Xnee-Internals" href="#Internals">8. Xnee Internals</a>
<ul class="toc">
<li><a name="toc-Synchronisation" href="#Synchronisation">8.1 Synchronisation</a>
<ul class="toc">
<li><a name="toc-Why-synchronise" href="#Why-synchronise">8.1.1 Why synchronise</a></li>
<li><a name="toc-How-to-synchronise" href="#How-to-synchronise">8.1.2 How to synchronise</a></li>
<li><a name="toc-Synchronisation-is-needed" href="#Synchronisation-is-needed">8.1.3 Synchronisation is needed</a></li>
<li><a name="toc-Different-data-for-different-kind-of-sessions" href="#Different-data-for-different-kind-of-sessions">8.1.4 Different data for different kind of sessions</a></li>
<li><a name="toc-Slow-replay-session-due-to-too-many-synchronise-data" href="#Slow-replay-session-due-to-too-many-synchronise-data">8.1.5 Slow replay session due to too many synchronise data</a></li>
<li><a name="toc-X-protocol-is-rich-and-asynchronous" href="#X-protocol-is-rich-and-asynchronous">8.1.6 X protocol is rich and asynchronous</a></li>
<li><a name="toc-Different-data-sent" href="#Different-data-sent">8.1.7 Different data sent</a></li>
<li><a name="toc-Buffers-and-timeouts" href="#Buffers-and-timeouts">8.1.8 Buffers and timeouts</a></li>
</ul>
</li>
</ul></li>
<li><a name="toc-Xnee-Requirements" href="#Requirements">9. Xnee Requirements</a>
<ul class="toc">
<li><a name="toc-Runtime-requirements" href="#Runtime-requirements">9.1 Runtime requirements</a></li>
<li><a name="toc-Development-requirements" href="#Development-requirements">9.2 Development requirements</a></li>
</ul></li>
<li><a name="toc-FAQ-1" href="#FAQ">10. FAQ</a></li>
<li><a name="toc-Copying-This-Manual-1" href="#Copying-This-Manual">A. Copying This Manual</a>
<ul class="toc">
<li><a name="toc-GNU-Free-Documentation-License" href="#GNU-Free-Documentation-License">A.1 GNU Free Documentation License</a></li>
</ul></li>
<li><a name="toc-Index-1" href="#Index">B. Index</a></li>
</ul>
</div>
<hr size="1">
<a name="SEC_Overview"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h1>Short Table of Contents</h1>
<div class="shortcontents">
<ul class="toc">
<li><a name="stoc-Summary-2" href="#Summary">1. Summary</a></li>
<li><a name="stoc-Getting-started-1" href="#Getting-started">2. Getting started</a></li>
<li><a name="stoc-Functional-overview-1" href="#Functional-overview">3. Functional overview</a></li>
<li><a name="stoc-Installation-1" href="#Installation">4. Installation</a></li>
<li><a name="stoc-Examples-1" href="#Examples">5. Examples</a></li>
<li><a name="stoc-Xnee-Programs" href="#Programs">6. Xnee Programs</a></li>
<li><a name="stoc-File-types-and-format" href="#File-format">7. File types and format</a></li>
<li><a name="stoc-Xnee-Internals" href="#Internals">8. Xnee Internals</a></li>
<li><a name="stoc-Xnee-Requirements" href="#Requirements">9. Xnee Requirements</a></li>
<li><a name="stoc-FAQ-1" href="#FAQ">10. FAQ</a></li>
<li><a name="stoc-Copying-This-Manual-1" href="#Copying-This-Manual">A. Copying This Manual</a></li>
<li><a name="stoc-Index-1" href="#Index">B. Index</a></li>
</ul>
</div>
<hr size="1">
<a name="SEC_About"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h1>About This Document</h1>
<p>
This document was generated by <em>Build Daemon user</em> on <em>January 2, 2018</em> using <a href="http://www.nongnu.org/texi2html/"><em>texi2html 1.82</em></a>.
</p>
<p>
The buttons in the navigation panels have the following meaning:
</p>
<table border="1">
<tr>
<th> Button </th>
<th> Name </th>
<th> Go to </th>
<th> From 1.2.3 go to</th>
</tr>
<tr>
<td align="center"> [ < ] </td>
<td align="center">Back</td>
<td>Previous section in reading order</td>
<td>1.2.2</td>
</tr>
<tr>
<td align="center"> [ > ] </td>
<td align="center">Forward</td>
<td>Next section in reading order</td>
<td>1.2.4</td>
</tr>
<tr>
<td align="center"> [ << ] </td>
<td align="center">FastBack</td>
<td>Beginning of this chapter or previous chapter</td>
<td>1</td>
</tr>
<tr>
<td align="center"> [ Up ] </td>
<td align="center">Up</td>
<td>Up section</td>
<td>1.2</td>
</tr>
<tr>
<td align="center"> [ >> ] </td>
<td align="center">FastForward</td>
<td>Next chapter</td>
<td>2</td>
</tr>
<tr>
<td align="center"> [Top] </td>
<td align="center">Top</td>
<td>Cover (top) of document</td>
<td> </td>
</tr>
<tr>
<td align="center"> [Contents] </td>
<td align="center">Contents</td>
<td>Table of contents</td>
<td> </td>
</tr>
<tr>
<td align="center"> [Index] </td>
<td align="center">Index</td>
<td>Index</td>
<td> </td>
</tr>
<tr>
<td align="center"> [ ? ] </td>
<td align="center">About</td>
<td>About (help)</td>
<td> </td>
</tr>
</table>
<p>
where the <strong> Example </strong> assumes that the current position is at <strong> Subsubsection One-Two-Three </strong> of a document of the following structure:
</p>
<ul>
<li> 1. Section One
<ul>
<li>1.1 Subsection One-One
<ul>
<li>...</li>
</ul>
</li>
<li>1.2 Subsection One-Two
<ul>
<li>1.2.1 Subsubsection One-Two-One</li>
<li>1.2.2 Subsubsection One-Two-Two</li>
<li>1.2.3 Subsubsection One-Two-Three
<strong><== Current Position </strong></li>
<li>1.2.4 Subsubsection One-Two-Four</li>
</ul>
</li>
<li>1.3 Subsection One-Three
<ul>
<li>...</li>
</ul>
</li>
<li>1.4 Subsection One-Four</li>
</ul>
</li>
</ul>
<hr size="1">
<p>
<font size="-1">
This document was generated by <em>Build Daemon user</em> on <em>January 2, 2018</em> using <a href="http://www.nongnu.org/texi2html/"><em>texi2html 1.82</em></a>.
</font>
<br>
</p>
</body>
</html>
|