File: Protocol-A.texi

package info (click to toggle)
lyskom-server 2.1.2-13
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd, wheezy
  • size: 10,384 kB
  • ctags: 5,091
  • sloc: ansic: 50,985; exp: 12,368; sh: 10,983; python: 2,927; makefile: 1,017; yacc: 465; awk: 340; lisp: 271; lex: 218; sed: 50
file content (11981 lines) | stat: -rw-r--r-- 398,815 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
10087
10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
10373
10374
10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
10424
10425
10426
10427
10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
10526
10527
10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
10562
10563
10564
10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
10625
10626
10627
10628
10629
10630
10631
10632
10633
10634
10635
10636
10637
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
10681
10682
10683
10684
10685
10686
10687
10688
10689
10690
10691
10692
10693
10694
10695
10696
10697
10698
10699
10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
10749
10750
10751
10752
10753
10754
10755
10756
10757
10758
10759
10760
10761
10762
10763
10764
10765
10766
10767
10768
10769
10770
10771
10772
10773
10774
10775
10776
10777
10778
10779
10780
10781
10782
10783
10784
10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
10817
10818
10819
10820
10821
10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
10841
10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
10853
10854
10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
10868
10869
10870
10871
10872
10873
10874
10875
10876
10877
10878
10879
10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
10891
10892
10893
10894
10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
10907
10908
10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
10988
10989
10990
10991
10992
10993
10994
10995
10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
11039
11040
11041
11042
11043
11044
11045
11046
11047
11048
11049
11050
11051
11052
11053
11054
11055
11056
11057
11058
11059
11060
11061
11062
11063
11064
11065
11066
11067
11068
11069
11070
11071
11072
11073
11074
11075
11076
11077
11078
11079
11080
11081
11082
11083
11084
11085
11086
11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
11108
11109
11110
11111
11112
11113
11114
11115
11116
11117
11118
11119
11120
11121
11122
11123
11124
11125
11126
11127
11128
11129
11130
11131
11132
11133
11134
11135
11136
11137
11138
11139
11140
11141
11142
11143
11144
11145
11146
11147
11148
11149
11150
11151
11152
11153
11154
11155
11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
11178
11179
11180
11181
11182
11183
11184
11185
11186
11187
11188
11189
11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201
11202
11203
11204
11205
11206
11207
11208
11209
11210
11211
11212
11213
11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
11255
11256
11257
11258
11259
11260
11261
11262
11263
11264
11265
11266
11267
11268
11269
11270
11271
11272
11273
11274
11275
11276
11277
11278
11279
11280
11281
11282
11283
11284
11285
11286
11287
11288
11289
11290
11291
11292
11293
11294
11295
11296
11297
11298
11299
11300
11301
11302
11303
11304
11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
11315
11316
11317
11318
11319
11320
11321
11322
11323
11324
11325
11326
11327
11328
11329
11330
11331
11332
11333
11334
11335
11336
11337
11338
11339
11340
11341
11342
11343
11344
11345
11346
11347
11348
11349
11350
11351
11352
11353
11354
11355
11356
11357
11358
11359
11360
11361
11362
11363
11364
11365
11366
11367
11368
11369
11370
11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
11387
11388
11389
11390
11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
11408
11409
11410
11411
11412
11413
11414
11415
11416
11417
11418
11419
11420
11421
11422
11423
11424
11425
11426
11427
11428
11429
11430
11431
11432
11433
11434
11435
11436
11437
11438
11439
11440
11441
11442
11443
11444
11445
11446
11447
11448
11449
11450
11451
11452
11453
11454
11455
11456
11457
11458
11459
11460
11461
11462
11463
11464
11465
11466
11467
11468
11469
11470
11471
11472
11473
11474
11475
11476
11477
11478
11479
11480
11481
11482
11483
11484
11485
11486
11487
11488
11489
11490
11491
11492
11493
11494
11495
11496
11497
11498
11499
11500
11501
11502
11503
11504
11505
11506
11507
11508
11509
11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
11525
11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
11567
11568
11569
11570
11571
11572
11573
11574
11575
11576
11577
11578
11579
11580
11581
11582
11583
11584
11585
11586
11587
11588
11589
11590
11591
11592
11593
11594
11595
11596
11597
11598
11599
11600
11601
11602
11603
11604
11605
11606
11607
11608
11609
11610
11611
11612
11613
11614
11615
11616
11617
11618
11619
11620
11621
11622
11623
11624
11625
11626
11627
11628
11629
11630
11631
11632
11633
11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
11651
11652
11653
11654
11655
11656
11657
11658
11659
11660
11661
11662
11663
11664
11665
11666
11667
11668
11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
11682
11683
11684
11685
11686
11687
11688
11689
11690
11691
11692
11693
11694
11695
11696
11697
11698
11699
11700
11701
11702
11703
11704
11705
11706
11707
11708
11709
11710
11711
11712
11713
11714
11715
11716
11717
11718
11719
11720
11721
11722
11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
11748
11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
11759
11760
11761
11762
11763
11764
11765
11766
11767
11768
11769
11770
11771
11772
11773
11774
11775
11776
11777
11778
11779
11780
11781
11782
11783
11784
11785
11786
11787
11788
11789
11790
11791
11792
11793
11794
11795
11796
11797
11798
11799
11800
11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
11815
11816
11817
11818
11819
11820
11821
11822
11823
11824
11825
11826
11827
11828
11829
11830
11831
11832
11833
11834
11835
11836
11837
11838
11839
11840
11841
11842
11843
11844
11845
11846
11847
11848
11849
11850
11851
11852
11853
11854
11855
11856
11857
11858
11859
11860
11861
11862
11863
11864
11865
11866
11867
11868
11869
11870
11871
11872
11873
11874
11875
11876
11877
11878
11879
11880
11881
11882
11883
11884
11885
11886
11887
11888
11889
11890
11891
11892
11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
11903
11904
11905
11906
11907
11908
11909
11910
11911
11912
11913
11914
11915
11916
11917
11918
11919
11920
11921
11922
11923
11924
11925
11926
11927
11928
11929
11930
11931
11932
11933
11934
11935
11936
11937
11938
11939
11940
11941
11942
11943
11944
11945
11946
11947
11948
11949
11950
11951
11952
11953
11954
11955
11956
11957
11958
11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
11969
11970
11971
11972
11973
11974
11975
11976
11977
11978
11979
11980
11981
\input texinfo                         @c -*-texinfo-*-
@c
@c %**start of header
@setfilename protocol-a.info
@settitle LysKOM Protocol A
@setchapternewpage odd
@c @afourpaper

@set PROTOEDITION 11.1
@set PROTOVER 11
@set VERSION 2.1.2



@c @holl{l, s} is used to construct Hollerith strings.  The main
@c reason to use this macro is to help the spell checker.

@macro holl {l, s}
\l\H\s\
@end macro


@c
@c Define a few strings that contains characters from ISO Latin-1.
@c

@iftex

@c ispell-ignore
@set IAM Inl@"agg @}t mig
@set Pell P@"ar Emanuelsson
@set Kent Kent Eng@-str@"om@penalty-10000
@set presconf @holl{27,Presentation (av nya) m@"oten}
@c ispell-end-ignore

@end iftex
@ifnottex

@c ispell-ignore
@set IAM Inlgg @}t mig
@set Pell Pr Emanuelsson
@set Kent Kent Engstrm
@set presconf @holl{27,Presentation (av nya) mten}
@c ispell-end-ignore

@end ifnottex

@c
@c Index setup
@c

@c Index for asynchronous messages.
@defcodeindex am

@c Merge all indices.
@syncodeindex am fn
@syncodeindex tp fn
@syncodeindex cp fn



@c
@c Special markup for this document.
@c

@c Indicate something that shouldn't be spell-checked
@macro badspell{s}
\s\
@end macro

@c @req{login} is used for protocol requests.

@macro req {n}
@code{\n\}
@end macro

@c @reqlink{login} is used for protocol requests, that should be linked.

@ifhtml
@macro reqlink {n}
@code{@ref{\n\}}
@end macro
@end ifhtml

@ifnothtml
@macro reqlink {n}
@code{\n\} (@pxref{\n\})
@end macro
@end ifnothtml

@c @reqdlink{login}...@linkhere{} is used for protocol requests, that
@c should be linked, where the link should occur a few words after the
@c request itself.

@ifhtml

@c HTML version: make the word a link.
@macro reqdlink {n}
@code{@ref{\n\}}
@unmacro linkhere
@macro linkhere
@end macro
@end macro

@end ifhtml

@ifnothtml
@ifnottex

@c Info version: create @linkhere as a macro that contains a reference.

@macro reqdlink {n}
@code{\n\}
@unmacro linkhere
@macro linkhere
(@pxref{\n\})
@end macro
@end macro
@end ifnottex

@iftex

@c TeX version: this produces output similar to the Info version.

@c ispell-ignore
@tex
    \gdef\reqdlink#1{%
        \code{#1}%
        \gdef\linkhere{ (\pxref{#1})}%
    }
@end tex
@c ispell-end-ignore
@end iftex
@end ifnothtml

@c @aux{mx-allow-filter} is used for aux-item names.
@macro aux {n}
@code{\n\}
@end macro

@c @async{async-login} is used for async names.
@macro async {n}
@code{\n\}
@end macro

@c @asynclink{async-login} is used for async names, that should be linked.

@ifhtml
@macro asynclink {n}
@code{@ref{\n\}}
@end macro
@end ifhtml

@ifnothtml
@macro asynclink {n}
@code{\n\} (@pxref{\n\})
@end macro
@end ifnothtml

@c @asyncdlink{async-login}...@linkhere{} is used for async messages,
@c that should be linked, where the link should occur a few words after
@c the async name itself.

@ifhtml

@c HTML version: make the word a link.
@macro asyncdlink {n}
@code{@ref{\n\}}
@unmacro linkhere
@macro linkhere
@end macro
@end macro

@end ifhtml

@ifnothtml
@ifnottex

@c Info version: create @linkhere as a macro that contains a reference.

@macro asyncdlink {n}
@code{\n\}
@unmacro linkhere
@macro linkhere
(@pxref{\n\})
@end macro
@end macro
@end ifnottex

@iftex

@c TeX version: this produces output similar to the Info version.

@c ispell-ignore
@tex
    \gdef\asyncdlink#1{%
        \code{#1}%
        \gdef\linkhere{ (\pxref{#1})}%
    }
@end tex
@c ispell-end-ignore
@end iftex
@end ifnothtml

@c @type{Conference} is used for LysKOM types.
@macro type {n}
@code{\n\}
@end macro

@c @lt{Conference} is used for linked types.  The link is only present
@c when it is unobtrusive.  It should only be used inside
@c @example...@end example.

@ifhtml
@macro lt {n}
@ref{\n\}
@end macro
@end ifhtml

@ifnothtml
@macro lt {n}
\n\
@end macro
@end ifnothtml

@c @priv{wheel} is used for privilege bits.
@macro priv {n}
@code{\n\}
@end macro

@c @conftype{rd-prot} is used for conference type bits.
@macro conftype {n}
@code{\n\}
@end macro

@c @misc{bcc-recpt} is used for misc-info names.
@macro misc {n}
@code{\n\}
@end macro

@c @rarg{passwd} is used to reference arguments of requests.  This is
@c *only* used in the nodes that defines the requests.
@macro rarg {n}
@code{\n\}
@end macro

@c @aarg{text-no} is used to reference arguments of asynchronous
@c messages.  This is *only* used in the nodes that defines the
@c relevant asynchronous message.
@macro aarg {n}
@code{\n\}
@end macro

@c @errorcode{no-such-text} is used to mark error codes.
@macro errorcode {n}
@code{\n\}
@end macro

@c @field{ident-user} is used to mark fields of struct types.
@macro field {n}
@code{\n\}
@end macro

@c @reqexample is used immediately before Protocol-A example
@c fragments.
@macro reqexample
@need 2000
@i{Example:}
@end macro

@c
@c Define strings that can be encoded as macros instead of with @set.
@c

@macro daemon
@badspell{d@ae{}mon}
@end macro


@c %**end of header

@copying
This is the LysKOM Protocol A specification, edition
@value{PROTOEDITION}.  It specifies version @value{PROTOVER} of the
protocol.  It was first distributed with version @value{VERSION} of
lyskomd.

Copyright @copyright{} 1995-2003 Lysator ACS.

@quotation
Permission is granted to make and distribute verbatim copies of this
specification provided the copyright notice and this permission notice
are preserved on all copies.

@c Permission is granted to process this file through TeX
@c and print the results, provided the printed document
@c carries a copying permission notice identical to this
@c one except for the removal of this paragraph (this
@c paragraph not being relevant to the printed manual).

Modified versions of this document may be redistributed with the added
condition that all modifications not cleared with the LysKOM development group
are clearly marked and that the entire modified work be redistributed under the
same conditions as the original.

Permission is granted to copy and distribute translations of this manual into
another language under the same conditions as for modified versions.
@end quotation
@end copying

@c ispell-ignore
@iftex
@c
@c Don't indent the first line of paragraphs.
@parindent 0pt
@c
@c Define @t{} so that it switches from slanted to regular to slanted
@c typewriter text as usages are nested. For example:
@c
@c     @t{A @t{B @t{C} D} E}
@c
@c will set A, C and E slanted and B and D as regular typewriter text.
@c This makes @t sort of the typewriter equivalent of LaTeX \em
@c (emphasis is italic, emphasized emphasis is roman).
@c
@c Helpers:
@c   \tensltt: switch to the cmsltt10 font (Computer Modern,
@c          Slanted, Typewriter, 10pt). 
@c   \rett: switch to typewriter text and define
@c          \t as an alias for \sltt.
@c   \sltt: switch to slanted typewriter text and defines
@c          \t as an alias for \rett.
@c
@c Finally \t is defined as an alias for \sltt.
@c
@tex
\global\font\tensltt=cmsltt10
\global\def\rett#1{{\let\t\sltt\tt #1}}
\global\def\sltt#1{{\fam\ttfam\tensltt\let\t\rett #1}}
\global\let\t\sltt
@end tex
@end iftex
@c ispell-end-ignore

@titlepage
@title{LysKOM Protocol A}
@subtitle{Protocol version @value{PROTOVER}}
@subtitle{Edition @value{PROTOEDITION}}
@subtitle{(lyskomd @value{VERSION})}
@author by the LysKOM Developers

@page
@c ispell-ignore
@vskip 0pt plus 1filll
@c ispell-end-ignore
@insertcopying

@end titlepage
@ifnothtml
@contents
@end ifnothtml

@dircategory LysKOM
@direntry
* Protocol A: (protocol-a).             The LysKOM Protocol A specification.
@end direntry

@c ispell-ignore
@ifhtml
@html
<a href="http://www.lysator.liu.se/" ><img
src="http://www.lysator.liu.se/icons/lyslogo.gif" alt="Lysator"
width=40 border=0 height=40 align=left ></a>

<a href="http://www.lysator.liu.se/lyskom/" ><img
src="http://www.lysator.liu.se/icons/lyskom.gif" alt="LysKOM" width=40
border=0 height=40 align=left ></a>
<br clear=all>
@end html
@end ifhtml
@c ispell-end-ignore

@node Top
@top LysKOM Protocol A

This document specifies version @value{PROTOVER} of LysKOM Protocol A.
This is edition @value{PROTOEDITION} of the specification.  It was
first distributed with version @value{VERSION} of lyskomd.

The most up-to-date version if this document can always be found at
@uref{http://www.lysator.liu.se/lyskom/protocol/}.

@menu
* About this document::         Copyright information.
* Preface::                     What is LysKOM?  Who wrote this document?
* Concepts::                    Articles, conferences, aux-items, @dots{}
* Fundamentals::                The building blocks of Protocol A.
* LysKOM Data Types::           Domain-specific data types used in Protocol A.
* Protocol Requests::           Each request explained in depth.
* Asynchronous Messages::       Unsolicited information from the server.
* Error Codes::                 All error codes with explanations.
* Aux-Item Types::              All predefined aux-item types.
* Name Expansion::              Looking up the name of a conference or person.
* LysKOM Content Types::        Predefined content types for articles.
* The User Area::               Store client-specific settings in the server.
* Membership visibility::       How the security features interacts.
* Garb::                        Old texts are deleted automatically.
* Measured Properties::         Load average, number of processed requests...
* Extracted grammar::           If you want to generate code, read this.
* Writing Clients::             A few tips for client writers.
* Importing and Exporting E-Mail::  A few thoughts on e-mail integration.
* Some Client-specific Aux-Item Types::  Informative info about more aux-items.
* Future changes::              The protocol is not yet perfect.
* Protocol Version History::    The protocol was even less perfect before.
* Document Edition History::    Changes in this document.
* Index::                       Index of protocol elements.
@end menu

@ifnottex
@node About this document
@chapter About this document

@insertcopying

@end ifnottex

@ifnottex
@node Preface
@chapter Preface
@end ifnottex

LysKOM is a conferencing system@footnote{Or in modern terms, enabling
technology for Computer-Supported Cooperative Work (CSCW).}.  Similar
systems were QZ-KOM and PortaCOM@footnote{Also known as ``PottaKOM'' and
``BortaKOM.''}.  The LysKOM system is copyrighted by Lysator Academic
Computing Society and distributed under conditions of the GNU Public
License.  LysKOM and its documentation is provided ``as is'' without
warranty of any kind.

Anything described here as ``unspecified'' is liable to change in
future protocol versions.

This specification is the work of several people.  The main contributors have
been
Per Cederqvist @email{ceder@@lysator.liu.se},
David Byers @email{byers@@lysator.liu.se},
@value{Pell} @email{pell@@lysator.liu.se},
Thomas Bellman @email{bellman@@lysator.liu.se},
Lars Aronsson @email{aronsson@@lysator.liu.se},
Linus Tolke @email{linus@@lysator.liu.se} and
@value{Kent} @email{kent@@lysator.liu.se}.

The LysKOM developers can be reached by email to
@email{lyskom@@lysator.liu.se}.  If you find any errors in this
document, please report them at
@uref{http://bugzilla.lysator.liu.se/}.  Use @samp{lyskomd} as the
product, and @samp{documentation} as component.

@node Concepts
@chapter Concepts used in LysKOM

This chapter introduces the concepts used in LysKOM, such as articles,
conferences and sessions.

@menu
* Articles::                    Reading and writing articles is what
                                  LysKOM is about.
* Conferences::                 Articles are organized in conferences.
* Persons and Sessions::        Persons log on to the LysKOM system.
* The Misc-Info List::          How articles are organized in comment
                                  chains and in conferences.
* The Aux-Item List::           A generic extension mechanism.
* Security::                    Some persons have more privileges than
                                  others.
* Membership and Reading::      You don't have to read anything twice.
@end menu


@node Articles
@section Articles

An article is represented as a value of the type @type{Text-Stat} and a
string containing the article contents.  An article will usually have one
or more recipients and may be a comment or footnote to other articles.
Each article is kept in the database until it is older than the
@field{nice} value of each of its recipients and it is not marked by any
user.

There is an array of @type{Misc-Info} included in the
@type{Text-Stat}.  This array contains information about recipients,
senders, comments and footnotes.

Each article is identified by a number, the global@footnote{The number
is not truly global; it is local to a specific LysKOM server.}
article number (the @type{Text-No}).  Global numbers are assigned in
ascending order to new articles, and are never reused.  If an article
has recipients it will also have a local number for each recipient
(the @type{Local-Text-No}).  Local numbers are used in some data
structures to provide more compact storage and to provide an ordering
of articles for a particular recipient.  Local numbers are assigned in
ascending order and are never reused for a particular recipient,
though different recipients will have articles with the same local
numbers.

Occasionally it is necessary to map between local and global numbers.
The server call @reqdlink{local-to-global} does this@linkhere{}.



@node Conferences
@section Conferences

Conferences hold articles.  They are represented in the protocol as a
data type called @type{Conference}.  Each conference has a
@dfn{creator}, the person who created the conference, and a
@dfn{supervisor}, a conference whose members can modify the conference.
If the supervisor is a person, the members of that person's mailbox
are supervisors, which in most cases is only that person.  Persons are
a special case: in addition to those who are supervisors for a certain
person because of the @field{supervisor} field, the person is always a
supervisor of himself.  There is one exception to this special case:
the person cannot use @reqlink{set-supervisor} to change who is his
supervisor.

We have also introduced a type called @type{UConference} (pronounced
micro-conf-stat) which holds a subset of the information contained in
the full @type{Conference} type.  Use the @type{UConference} type
whenever possible since it places a much smaller load on the LysKOM
server.

Each conference has a type, which is essentially a collection of
boolean flags.  Currently the flags @conftype{rd-prot},
@conftype{letterbox}, @conftype{secret}, @conftype{original},
@conftype{allow-anonymous} and @conftype{forbid-secret} are defined.

@table @conftype
@item rd-prot
The conference is protected from reading by non-members.  Persons become
members by having one of the existing members or supervisors add him or
her to the conference.  This restriction is enforced by the server.
@item original
Conferences of this type are intended for original articles only.
Comments are to be redirected to the @field{super-conf} instead.  This
restriction is not enforced by the server; clients must implement this
functionality.  (@xref{Recipients of comments}, for a summary of how
a client should select the recipients of a comment.)
@item letterbox
Conferences of this type are connected to persons.  Letters to a person
are sent to the mailbox and the name of the mailbox is synchronized
with the person name.  It is currently not possible to explicitly set or
clear this flag on a conference.
@item secret
Conferences of this type are secret.  The server will not divulge any
information about the existence of the conference to persons who are not
members or supervisors of the conference.  If a mailbox is made secret,
that person cannot log in using the person name, but must specify a
person number instead.
@item allow-anonymous
Conferences of this type accept anonymous articles.  Other conferences
will reject anonymous articles.
@item forbid-secret
Conferences of this type do not allow secret members.  If a conference is
changed to this type, preexisting secret members remain secret.
@end table



@node Persons and Sessions
@section Persons and Sessions

Persons are represented in the protocol by values of the type
@type{Person}.  Associated with persons are statistics, a set of personal
flags and a set of privileges (@pxref{Security}).  Persons are also
associated with a conference that has the same number as the person and
the @conftype{letterbox} bit set.

Connections to the server are represented as values of the type
@type{Static-Session-Info}, @type{Session-Info-Ident} or
@type{Session-Info}.  Sessions have session number that are unique for
each session in the lifetime of the server execution.  A single user can
have several sessions running at once.  The session is not released until
the network connection is closed; a user can log in and out repeatedly
in a single session.


@node The Misc-Info List
@section The Misc-Info List

The @type{Misc-Info} list contains tagged data.  The fields are sent in
groups pertaining to a particular type of information: information about
recipient; carbon copy recipient; blank carbon copy recipient;
comment to; footnote to; comment in
and footnote in.  The information groups may be sent in any order and
there may be any number of groups.  Within each group the elements are
always sent in the order listed below.

@subsection Recipient

@table @misc
@item recpt
Starts a recipient group.  It contains the conference number of a
recipient of the article.
@item loc-no
Always present within a recipient group.  It contains the local text
number of the article in the conference specified by the preceding
@misc{recpt} field.
@item rec-time
If the recipient is a person, this element is added by the server when
the recipient marks the article as read.  It contains the time when the
text was read.
@item sent-by
Present when the recipient was added by a person other than the author
(after the article was created.) It contains the person number of the
person who added the recipient.
@item sent-at
Present when the recipient was added after the article was created.  It
contains the time when the recipient was added.
@end table


@subsection Carbon Copy (CC) Recipient

The carbon-copy recipient group is identical to the recipient group
above.  The difference is how new comments to an article with a recipient
or carbon-copy recipient are treated.  A comment to an article is sent to
all recipients, but not to carbon-copy recipients of the original
article.  This difference is enforced by the clients.

@table @misc
@item cc-recpt
Starts a carbon-copy recipient group.  It contains the conference number
of a carbon-copy recipient of the article.
@item loc-no
Always present in a CC recipient group.  It contains the local text
number of the article in the conference specified by the most recent
@misc{cc-recpt} field.
@item rec-time
Present after the CC recipient has read the article.  It contains the
time when the article was read.  Since only persons can read articles
this will only be seen if the CC recipient is a person.
@item sent-by
Present when a CC recipient was added by a person other than the author
after the article had been created.  It contains the person number of the
person who added the CC recipient.
@item sent-at
Present when a CC recipient was added after the article had been
created.  It is the time when the CC recipient was added.
@end table


@subsection Blank Carbon Copy (BCC) Recipient

The blank carbon-copy recipient group is identical to the carbon-copy
recipient group above.  The difference is the visibility of the
information.  A carbon-copy recipient group is visible to anyone that is
allowed to fetch both the text status of the involved text and the
conference status of the involved conference.  (That is, as long as the
conference isn't secret everybody is allowed to see the carbon-copy
recipient group.)

A BCC recipient group is basically only visible to members and
supervisors of the recipient.  Persons that have the right to become a
member of the recipient can also see it, as can the author of the text
(unless the recipient is secret to him).  This is enforced by the
server.

This type of group was introduced in protocol version 10.  When
old-style calls such as @reqlink{get-text-stat-old}
are used this will be converted to a CC recipient group by the server
for the benefit of clients that don't understand this group.  (This
conversion will of course only be performed when the user is allowed
to se the blank carbon copy.)

@table @misc
@item bcc-recpt
Starts a blank carbon-copy recipient group.  It contains the conference
number of a blank carbon-copy recipient of the article.
@item loc-no
Always present in a BCC recipient group.  It contains the local text
number of the article in the conference specified by the most recent
@misc{bcc-recpt} field.
@item rec-time
Present after the BCC recipient has read the article.  It contains the
time when the article was read.  Since only persons can read articles
this will only be seen if the BCC recipient is a person.
@item sent-by
Present when a BCC recipient was added by a person other than the author
after the article had been created.  It contains the person number of the
person who added the BCC recipient.
@item sent-at
Present when a BCC recipient was added after the article had been
created.  It is the time when the BCC recipient was added.
@end table


@subsection Comment To

@table @misc
@item comm-to
Always present when the article is a comment to another article.
@item sent-by
Present when the article was added as a comment by a person other than
the author, after the article had been created.  It contains the person
number of the person who added the article as a comment.
@item sent-at
Present when the article was added as a comment after the article had
been created.  It contains the time when it was added as a comment.
@end table


@subsection Footnote To

@table @misc
@item footn-to
Always present when the article is a footnote to another article.
@item sent-at
Present when the article was added as a footnote after the article had
been created.  It contains the time when it was added as a footnote.
@end table


@subsection Comment in

@table @misc
@item comm-in
Present when there are comments to this article.  It contains the article
number which is a comment to this article.
@end table


@subsection Footnote in

@table @misc
@item footn-in
Present when there are footnotes to this article.  It contains the
article number which is a footnote to this article.
@end table


@node The Aux-Item List
@section The Aux-Item List

The aux-item list is used as a generic extension mechanism in the LysKOM
server and in protocol A.

@menu
* About Aux-Items::             An introduction to aux-items.
* Aux-Item Inheritance::        Comments can inherit aux items.
* Predefined Aux-Item Types::   Predefined aux-items are part of the protocol.
* Client-Specific Aux-Item Types::  Clients can allocate aux-items for
                                    their private use.
* Experimental Aux-Item Types::  A block of aux-items are reserved for
                                    experimental use.
* Defining New Aux-Item Types::  Creating new aux-item types is easy.
@end menu

@node About Aux-Items
@subsection About Aux-Items

Aux-items were introduced in protocol version 10 as a mechanism for
extending the conference, text and server information structures without
changing the protocol.  (There is no need for aux-items on persons --
just add an aux-item to the corresponding mailbox.)

The exact structure of an aux item is specified elsewhere
(@pxref{Auxiliary Information}).  The important fields here are the
@field{aux-no}, @field{tag} and @field{data} fields.

The @field{aux-no} field is used to identify an item.  The
@field{aux-no} together with a text or conference number uniquely
identifies a particular aux item.  Items are numbered from one and up
within each item list.  Once assigned, the @field{aux-no} for an item
is never changed.  New items are guaranteed to be assigned numbers that
have never been used before within a particular list.

The @field{tag} field identifies the type of aux item.  It is used by
the server and by clients to figure out how to interpret the data
field, and by the server to decide if the item needs special
treatment.

The @field{data} field is a simple string.  The meaning of the string
is determined by the @field{tag} field, but since it is a string,
clients that have no understanding of the contents can successfully
parse the item anyway (in contrast to items in the misc-info list.)



@node Aux-Item Inheritance
@subsection Aux-Item Inheritance

An aux item that is placed on a text can be inherited.  This means
that if a comment or footnote to the text is created, an almost
identical item will be created on the new text.  The @field{tag},
@field{creator}, @field{flags} and @field{data} field will be
inherited unchanged.  The @field{aux-no} might be given a different
value.  A non-zero @field{inherit-limit} field will be decremented.
The @field{created-at} timestamp will be set to the time when the new
comment or footnote is created.

Inheritance only happens at text creation time.  If a comment or
footnote link is added later with @reqlink{add-comment} or
@reqlink{add-footnote}, no items will be inherited.  Also, if the link
is removed (via @reqlink{sub-comment} or @reqlink{sub-footnote}), the
inherited items will still be in place.

Inheritance only happens when the @field{inherit} bit is set, and if
@field{inherit-limit} is 0 or greater than 1.  @xref{Auxiliary
Information}, for more information.

Inheritance has no meaning for items placed on the server or on a
conference.

It is possible for a predefined aux-item to behave in a way that isn't
consistent with the description in this section.  The documentation
for the specific aux-item should document any deviations.



@node Predefined Aux-Item Types
@subsection Predefined Aux-Item Types

Predefined Aux-Item types are part of Protocol A, and clients should
support all of them.  As with other parts of the protocol, changes to
these definitions will be made backwards-compatible, if possible.

Creation and deletion of items with a predefined type can cause
arbitrarily complex and wondrous behavior in the server.  Furthermore,
the server may place constraints on the items with regard to content,
flags, who can create them, to what objects they can be attached and
so forth.  The server may also silently enforce specific values for any
field of an item, regardless of what the client requests.

All items with tags in the range 1-9999 and 30000 and up are considered
predefined.  If a client attempts to create an item with a tag in this
range, but the server has no idea what that tag means, the server will
return an error (@errorcode{illegal-aux-item}).

Some items with tags in the range 10000-19999 are also predefined.
They are items that initially were reserved for private use for a
specific client, but where it was later discovered that the tag was
generally useful.  They should ideally have been assigned a number in
the 1-9999 range from the beginning, but if they already have a
widespread use they can be redefined to be predefined.  Such
redefinition will always be made in cooperation with the client
writer.

@xref{Aux-Item Types}, for the complete list of predefined Aux-Item
types.

@node Client-Specific Aux-Item Types
@subsection Client-Specific Aux-Item Types

Client-specific items do not cause the server to perform any magic.  All
the flags (except the delete flag) are left untouched, the data is not
validated in any way, and anyone can create any item.  If you need more
server support than this, your item should be on the predefined list.

All tags in the range 10000-19999 are reserved for clients.  Blocks of
100 numbers at a time can be assigned to specific clients.  A client
should never create items with tags in a range assigned to another
client or in an unassigned range.  Assigned ranges will never change,
except that specific aux-items may be redefined as predefined, as
explained in @ref{Predefined Aux-Item Types}.

Currently, the following ranges are assigned to clients:
@itemize @bullet
@item 10000-10099: The Elisp Client
@item 10100-10199: komimportmail
@item 10200-10299: Private test use (should never be used on a public server)
@end itemize

If you want a range of numbers, send e-mail to the LysKOM development
group, or request it via Bugzilla.

@node Experimental Aux-Item Types
@subsection Experimental Aux-Item Types

Experimental numbers are free for all.  Use @badspell{'em} any way you
want.  All
numbers in the range 20000-29999 are for experimental use.



@node Defining New Aux-Item Types
@subsection Defining New Aux-Item Types

If you want a new predefined item type, just document what it does, what
the data format looks like and what the server is to do with the item
and send this to the LysKOM development group.  We'll assign a number to
your item and put the documentation in this document.

If you're not sure what you want the data to look like yet, make a note
in your documentation that the data format might change.  Once you have a
data format you're happy with, update the documentation so others may
use your item.

If you need serious magic in the server (more than can be specified with
the lyskomd configuration file), you'll probably have to write the code
yourself, or hope that the development group thinks your idea is so cool
we do the job for you.

The idea is not to reject any type of item, unless there's already an
item type that does the job just as well.  Adding item types should be a
much less painful process than adding new calls.





@node Security
@section Security

Security in LysKOM is based on two components.  Each person has a set
of privileges and each session has a security level.  Rights in the
system require both the sufficient privileges and a sufficient
security level.  The privileges currently available are @priv{wheel},
@priv{admin}, @priv{statistic}, @priv{create-conf}, @priv{create-pers}
and @priv{change-name}.  Security levels range from 0 to 255.

@table @priv
@item wheel
@emph{Normally not assigned}
@table @asis
@item Level 0
Person may always log in, even when LysKOM is crowded.
@item Level 6
Person may set Priv-Bits for all persons.
@item Level 7
Person may set password for all persons.
@item Level 8
Person acts as supervisor for everything.
@item Level 10
Person can read all articles.
@end table

@item admin
@emph{Normally not assigned}
@table @asis
@item Level 1
Shut down the server@*
Set motd-of-kom@*
Read last-login
@item Level 2
Read status of secret conferences and persons@*
Read the protected parts of person and conference statuses@*
Read the entire text status, even when there are secret recipients
@item Level 3
Change everybody's names
@item Level 4
Add/remove members@*
Add/remove recipients to articles
@item Level 5
Set super-conference@*
Remove articles
@item Level 6
Set administrator
@end table

@item statistic
@emph{Normally not assigned}
@table @asis
@item Level 2
Read the statistics portions of persons, even if protected
@end table

@item create-conf
@emph{Normally not assigned}@footnote{The LysKOM server is normally
configured so that anybody can create new conferences, even if they do
not have this privilege.}
@table @asis
@item Level 0
Create conferences
@end table

@item create-pers
@emph{Normally not assigned}@footnote{The LysKOM server is normally
configured so that anybody can create new persons, even if they do not
have this privilege.}
@table @asis
@item Level 0
Create persons
@end table

@item change-name
@emph{Normally assigned}
@table @asis
@item Level 0
Change names of conferences he is supervisor for
@end table

@end table


@node Membership and Reading
@section Membership and Reading

Persons' memberships in conferences are represented in the protocol as
arrays of @type{Membership}-typed values.  This structure contains
information about how and when the membership was created and which
texts have been read in the conference.

There are two kinds of memberships.  An active membership indicates that
the person is actively participating in the conference, wants to know if
there are unread texts and wants to receive messages send to the
conference.  A passive membership is similar to no membership at all.  The
person is still a member but will not receive messages sent to the
conference and will not be notified when there are new texts.  From the
user's perspective, passive membership should be like no membership at
all, but the server still remembers what the user has read in the
conference while he or she was an active member.  Since protocol version
10 a bit in the membership type field of the membership structure
indicates the type of membership.  Previously the server did not support
passive memberships, but there was a convention that clients should
treat the priority level zero as a passive membership.

The membership record indicates which texts have been read through the
@field{read-ranges} field, which contains a list of ranges of local
text numbers that has been read.

Finding out which articles a person has read in a particular conference
requires a few calls.  Normally, a client will retrieve a batch of
perhaps 50 articles at a time.  The outline of the process is as follows:

@enumerate
@item Fetch the membership to get the @field{read-ranges}.
@item Use @reqlink{local-to-global} to translate a number of local
numbers to global numbers.
@item Remove the global numbers corresponding to local numbers contained
in @field{read-texts} from the result.
@item Get and translate more texts as needed.
@end enumerate

The process is complicated because of the translation between local
and global text numbers.  If the server does not implement the
@reqdlink{local-to-global} call@linkhere{}, it is possible to use the less
efficient but perfectly serviceable @reqdlink{get-map} call
instead@linkhere{}.


@node Fundamentals
@chapter Fundamentals of Protocol A

The data types in protocol A come in two flavors.  The first (vanilla)
are the simple data types from which the LysKOM (chocolate) data types
are built.  Simple data types include things like integers and strings
while complex data types include things such as conferences and people.

@menu
* Notation::                    The grammar used in this document.
* Simple Data Types::           BOOL, INT32, ARRAY, @dots{}
* Connecting to the Server::    The initial handshake.
* Client-Server Dialog::        Requests, replies, asynchronous messages.
* Protocol Error Messages::     How the server reacts to syntax errors.
@end menu

@node Notation
@section Notation

This specification uses a BNF-like grammar to describe the protocol and
its data elements.

Data fields have been given names that start with a lower-case letter.

Fundamental data types have names in all-caps (such as @type{INT32} and
@type{ARRAY}).

Derived data types have names that start with an upper-case letter.  (If
the type contains more than one word, all words start with an upper-case
letter, like this: @type{Text-Stat}.)  The operator @code{::=} defines
the name to its left.

Comments start with @code{!} (exclamation mark) and alternatives are
separated by a @code{|} (vertical bar.) A @code{;} (semicolon)
terminates statements in the grammar.  In some specifications there are
literal strings.  There is to be no whitespace before or after literal
strings unless there is whitespace in the literal itself.


@node Simple Data Types
@section Simple Data Types

@anchor{INT32}
@anchor{INT16}
@anchor{INT8}
@anchor{BOOL}
@subsection Integers

@tindex INT32
@tindex INT16
@tindex INT8
@tindex BOOL
@type{INT32}, @type{INT16}, @type{INT8} and @type{BOOL} are non-negative
integers which must fit in 32, 16, 8 and 1 bits, respectively.  They are
transmitted to the server in ASCII-encoded decimal notation.

@anchor{FLOAT}
@subsection Floating point numbers

@tindex FLOAT
@type{FLOAT} are floating point numbers.  They are represented as if
printed via @code{printf("%g", val);} in C.  See @cite{7.19.6.1 The
fprintf function} in @cite{ISO/IEC 9899:1999 Programming languages -
C} for the details.  @xref{Floating-Point Conversions, , The %g
conversion, libc, The GNU C Library Reference Manual}, if you don't
have the C standard handy.

@anchor{HOLLERITH}
@subsection Strings

@tindex HOLLERITH
@type{HOLLERITH} denotes character strings of arbitrary length.  They are
transmitted as @code{@var{n}H@var{text}} where @var{text} is the string and
@var{n} is the number of characters in @var{text} in decimal
notation.  All byte values are allowed in the string itself, including
nulls.

Long live FORTRAN!

@cindex character set
@cindex Unicode
The character set used in the strings is not yet specified by Protocol
A.  In the future, some Unicode encoding will probably be used, but it
is not yet decided which one or how the transition will be handled.
@uref{http://bugzilla.lysator.liu.se/show_bug.cgi?id=99, Bug 99} is
about the need for a Unicode roadmap; check that bug for the current
state of the plans.

For now, which character set to use is a local policy of each server
installation.  There is not yet any way in the protocol to specify the
character set that a certain server uses.  Most clients currently
assume that ISO 8859-1 (Latin-1) is used, and the default collate
table of lyskomd also assumes ISO 8859-1.  Conference names must
currently use an 8-bit character set encoding where whitespace is
defined as in ASCII, or conference matching won't work.
@reqlink{get-collate-table} contains some more information about
character set issues.


@anchor{BITSTRING}
@subsection Bit Strings

@tindex BITSTRING
@type{BITSTRING} is a string of bits, commonly used for a set of
boolean-valued flags.  Bit strings are denoted as

@example
        BITSTRING ( name-1; name-2; name-3; @dots{} )
@end example

in this specification.  They are transmitted as a sequence of ASCII ones
and zeroes in the order the fields are listed.

For instance, given the specification

@example
        shape-of-world ::= BITSTRING (
                is-flat;
                is-round;
                is-2d;
                is-3d;
        )
@end example

most peoples idea of @code{shape-of-world} would be sent as @code{0101}
(round and three-dimensional.)


@anchor{ENUMERATION}
@subsection Enumerations

@tindex ENUMERATION
@type{ENUMERATION} is an integer constant.  It is transmitted as an INT32,
but only fixed values are permitted.  Clients should be prepared to
receive numbers outside the enumeration and either handle this
gracefully as an error or use a reasonable default value in place of an
invalid enumeration value.

An enumeration is specified as

@example
        ENUMERATION (
                name-1=value-1;
                name-2=value-2;
                name-3=value-3;
                @dots{}
        )
@end example

This specification states that name-1 is represented by the integer
value-1, name-2 is represented by value-2 and name-3 is represented by
value-3.

An enumeration can also be inherited from a SELECTION data type:

@example
        Info-type ::= ENUMERATION-OF(Misc-Info)
@end example

This means that Info-type is an enumeration, that contains the same keys
and values as the SELECTION Misc-Info.

For example, in the following specification, the constant guwal will be
transmitted as the integer 2, ciokwe as the integer 3, and hopi as the
integer 5.

@example
      language ::= ENUMERATION ( hakka      = 1;
                                 guwal      = 2;
                                 ciokwe     = 3;
                                 yoruba     = 4;
                                 hopi       = 5;
                )
@end example




@anchor{ARRAY}
@subsection Arrays

@tindex ARRAY
@type{ARRAY} is a list of a fixed number of elements of a single type.
The specification for an array is @code{ARRAY @var{type}} where
@var{type} is the type of the array elements.

Arrays are transmitted as an @code{@var{n} @{ @var{element}
@var{element} @dots{} @}} where @var{n} is the number of elements and
each @var{element} is an element of the array.  A special case is when
the array is empty, in which case the server transmits it as @code{0 *}.
Note that the client must always transmit empty arrays as @code{0 @{
@}}.

In some calls the client can ask the server not to send the array
contents, only its length.  In these cases the array is transmitted as
@code{@var{n} *} where @var{n} is the number of elements in the array.


@anchor{SELECTION}
@subsection Selection

@tindex SELECTION
@type{SELECTION} is tagged data.  It consists of an INT32 selector
followed by a tail of an arbitrary type and is specified as

@example
        SELECTION (
                @var{n}=@var{name}        @var{tail} : @var{type};
                @var{n}=@var{name}        @var{tail} : @var{type};
                @dots{}
        )
@end example

where each @var{n} is the selector value, @var{name} the selector
name and @var{tail} the name of the selector tail and @var{type}
its type.  @var{name} and @var{tail} are often very similar, such
as @samp{sent-by} and @samp{sender}.

When transmitted, the selector is transmitted as an INT32 followed by
the tail belonging to that selector.  For instance, given the
specification

@example
        description ::= SELECTION (
               1=name           the_name : HOLLERITH;
               2=age            years    : INT32;
        )
@end example

two legal messages of the type @code{description} are @samp{1
@holl{4,John}} and @samp{2 18}.


@anchor{RPC}
@subsection RPC

@tindex RPC
@type{RPC} is a notation used to specify calls to the server.  An RPC
specification has the following form:

@example
        RPC (
                @var{call} [@var{n}] ( @var{request} ) -> ( @var{reply} ) ;
                @var{call} [@var{n}] ( @var{request} ) -> ( @var{reply} ) ;
        )
@end example

where each @var{call} is the name of a call, @var{n} is the call
number, @var{request} is a single data element sent as a request and
@var{reply} is a single data element sent in reply from the server.

RPC calls are transmitted as @var{n} @var{request} where @var{n} and
@var{request} have the same meaning as above.  Note that in the
client-server dialog a reference number must also be supplied with each
request.  This reference number is not part of the RPC itself, but is
required for communications; see @ref{Client-Server Dialog}.



@subsection Structure

Structures are collections of several data items.  In the specification
they are written as

@example
        ( @var{name} : @var{type} ;
          @var{name} : @var{type} ;
          @dots{}
        )
@end example

where each @var{name} is the name of a data field and the
corresponding @var{type} is its type.

Structures are transmitted as a sequence of their fields.


@node Connecting to the Server
@section Connecting to the Server

The client-server dialog consists of two phases, establishing the connection
and the LysKOM session itself.

A connection to the server is initiated by connecting to the appropriate
network port@footnote{The default port for a LysKOM server is 4894.
That port was registered with IANA 2001-06-20.} and
sending a single letter which is used to select a protocol version.
This letter should always be @samp{A}@footnote{In the early 1990s
there was much discussion about the next generation LysKOM protocol,
called ``Protocol B'', and at one point in time it was believed that
``Protocol B'' would arrive at the same time as ``Emacs 19''.  ``Emacs
19'' arrived and was obsoleted by new versions.  Meanwhile, it was
discovered that ``Protocol A'' was more extensible that first
believed.  ``Protocol A'' will continue to evolve, but it is unlikely
that it will ever be superseded by ``Protocol B''.}.

The protocol version letter should be
followed by connection information required by that protocol.  In
protocol A the connection information is a @type{HOLLERITH} string saying who
the user connecting is followed by a linefeed character.

The format of the string should be @samp{@var{username} % @var{hostname}}.

When the server has accepted the connection it replies with the string
@code{LysKOM} on a single line.

@example
        % telnet kom.lysator.liu.se 4894
        Trying 130.236.254.151 ...
        Connected to varg.lysator.liu.se.
@c This comment matches the bracket on the next line: [
        Escape character is '^]'.
        A@holl{26,byers%kajsa.lysator.liu.se}
        LysKOM
@end example

Besides the string @samp{LysKOM}, the server may respond with
@samp{%%LysKOM unsupported protocol.} or @samp{%% No connections left.}.

The @samp{%%LysKOM unsupported protocol.} reply is sent if the server
does not understand the requested protocol, that is, if the first
character is anything but an @samp{A}.  The connection will be closed
by the server as soon as this string has been sent.

The @samp{%% No connections left.} reply is sent if the server is not
accepting additional connections.  This error is transient.  The next
connection attempt may succeed.  Clients should wait a few seconds before
attempting to make another connection after receiving this error.
The connection will be closed by the server as soon as this string has
been sent.

@node Client-Server Dialog
@section Client-Server Dialog

After connecting (@pxref{Connecting to the Server}), calls to the
server can be made.  Most calls require
the user to log in, but some calls can be made without a log-in.  Calls
to the server are made by sending a reference number followed by the
call as specified.  The call @emph{must} be terminated with a linefeed
character (ASCII 0x0A).

@example
        server-call ::=
                ( ref-no        :       INT32;
                  request       :       Protocol-Request;
                )
@end example

The client may send several requests without waiting for the replies.
However, the server will only buffer a limited amount of replies, so
the client must check for pending replies from the server at least
each time it sends requests to the server.

At some future point the server will reply with the result of the
request or an error code preceded by an indicator and the reference
number.  The replies will be sent in the same order as the
requests@footnote{Client writers are encouraged to write the clients
so that they are prepared for replies that are sent out-of-order.
@xref{Future changes}, for speculations about how that may benefit the
client in the future.}.

@example
        server-reply ::= ok-reply | error-reply | protocol-error;

        ok-reply ::=
                ( "="
                  ref-no        :       INT32;
                  reply-data;
                )

        error-reply ::=
                ( "%"
                  ref-no        :       INT32;
                  error-code    :       INT32;
                  error-status  :       INT32;
                )

        protocol-error ::= "%% LysKOM protocol error."
                         | "%%Insane token length."
                         | "%%Insane array size."
@end example

Our notation is not flexible enough to specify the two-way nature of
the communication.  @field{ref-no} in the reply is always the same as
@field{ref-no} in the corresponding request.  @field{reply-data}
depends on which request was made and is specified together with each
request.

Note that there is no whitespace after the initial indicator in the
reply.

Data elements sent from the client to the server are separated by one or
more space characters (ASCII 32).  An entire call is terminated by a
linefeed character (ASCII 10).

Earlier versions of the protocol specified that data elements could be
separated by any number of linefeed (ASCII 10), return (ASCII 13), tab
(ASCII 9) or space (ASCII 32) characters.  Servers should be forgiving
and understand requests using the older conventions, but clients must
conform to the current convention of separating data elements with
spaces and terminating all requests with a linefeed character.  The
@errorcode{not-implemented} error code will not be returned properly
unless the client follows this requirement.

The server may return two different types of errors.  Normal
@code{error-reply} errors are replies to syntactically correct calls
to the server, while @code{protocol-error} are replies to syntactically
incorrect calls.  @xref{Protocol Error Messages}, for more information
about @code{protocol-error}.

If a call cannot complete successfully, LysKOM will respond with an
@code{error-reply}.  The meaning of @field{error-code} and
@field{error-status} varies depending on the request; see @ref{Error
Codes}, and the documentation for each call, for a list of available
@field{error-code} values and what they mean.

A client should be prepared for any error code in response to any
call, no matter if the response makes any sense or not.  The value
returned in @field{error-status} was more or less undefined before
protocol version 10.  For protocol version 10 or newer, the meaning of
@field{error-status} is defined in this document.

The meaning of @field{error-status} can be modified by any call.  In
particular the calls that deal with Misc-Info lists set
@field{error-status} to the index of the misc item that caused the error
(if the error was caused by a misc item.)

Client should handle the error messages listed with each call in a
graceful manner.  In addition, the following error types should always
be handled gracefully: @errorcode{temporary-failure},
@errorcode{internal-error}, @errorcode{feature-disabled},
@errorcode{not-implemented}, @errorcode{obsolete-call},
@errorcode{ldb-error}, 
@errorcode{out-of-memory}.  Client should also be able to handle any
error in any situation without choking completely since bugs might
cause the wrong error message to be sent or new errors might be added
later on.

The server may send asynchronous messages (@pxref{Asynchronous
Messages}) to the client at any time (but not in the middle of a
reply).  Two important asynchronous messages are
@async{async-new-text} (@pxref{async-new-text}) and
@async{async-send-message} (@pxref{async-send-message}).

@node Protocol Error Messages
@section Protocol Error Messages

Protocol error messages are sent in reply to syntactically incorrect
calls to the server.  These
should never appear in the client-server dialog.  If they do, there is
probably a bug in the client.

@table @asis
@item "%% LysKOM protocol error."
The client has sent a request that does not comply with protocol A.  The
server will attempt to recover from this error, but additional calls may
be silently lost, and the server may send replies that the client does
not expect, and in some cases recovery may not be possible.
This error is also returned when the client sends an array
that is longer than the maximum allowed by the server.

@item "%%Insane token length."
The client has sent a single token that is insanely long.  Typically this
means that the client has sent several kilobytes worth of digits, or
something similar.  This is never returned for long strings.  The server
will automatically disconnect a client who sends a token with an insane
length.

@item "%%Insane array size."
The client has send an array with a negative length.  The server is not
easily fooled.  The server will automatically disconnect a client who
sends an array with an insane length.

@end table


@node LysKOM Data Types
@chapter LysKOM Data Types

In this section the data types specific to LysKOM are defined.  Most of
these will probably make very little sense until you know what calls
there are.  This section does not include the server calls or
asynchronous messages, even though these are also data types.

Since the types defined here are all based on the simple types, the
definitions are more concise in this section.

@menu
* Common Types::                Simple types used over and over again.
* Auxiliary Information::       Aux-items and related types.
* Conference Types::            A few flags for conferences.
* Conference Search Results::   Name lookup returns these types.
* Conference Status Types::     Information about a conference.
* Archaic way to list conferences::  Archaic name lookup result type.
* Mapping Local to Global Text Numbers::  The Text-Mapping type.
* Server Information::          Information about an installation.
* Person Status Types::         Information about a person.
* Membership Information::      Persons are members of conferences.
* Article Marks::               Persons can mark articles.
* Article Information::         Information about an article.
* Who Information::             Old-style info about logged-on users.
* Session Information::         New-style info about logged-on users.
* Statistics::                  The server measures several things.
@end menu

@node Common Types
@section Common Types

The types defined in this section are fairly simple and used in many of
the more complex data types.

@anchor{Time}
@subsection Time

@tindex Time
@example
        Time ::=
              ( seconds         :       @lt{INT32};
                minutes         :       @lt{INT32};
                hours           :       @lt{INT32};
                day             :       @lt{INT32};
                month           :       @lt{INT32};
                year            :       @lt{INT32};
                day-of-week     :       @lt{INT32};
                day-of-year     :       @lt{INT32};
                is-dst          :       @lt{BOOL};
              )
@end example

@type{Time} is used to specify times in several data structures.  The
fields @field{seconds}, @field{minutes} and @field{hours} give wall clock
time.  @field{day} is the day of month and @field{month} is the current
month, starting with zero for January.  @field{year} is the number of
years since 1900.  @field{day-of-week} is the current weekday, with zero
used for Sunday.  @field{day-of-year} is how many days of the year have
passed starting with zero and @field{is-dst} is true when the time
indicated is daylight savings time.

When the server receives a @type{Time} structure from a client it
ignores the @field{day-of-week} and @field{day-of-year} fields.

All times are expressed in the time zone of the server, unless the
@reqdlink{set-connection-time-format} request is used@linkhere{}.

@anchor{Conf-No}
@subsection Conference Numbers

@tindex Conf-No
@example
        Conf-No         ::=     @lt{INT16};
@end example

This type denotes a conference number.


@need 1511
@anchor{Text-No}
@anchor{Local-Text-No}
@anchor{Text-List}
@subsection Text Numbers

@tindex Text-No
@tindex Local-Text-No
@tindex Text-List
@example
        Text-No         ::=     @lt{INT32};
        Local-Text-No   ::=     @lt{INT32};
        Text-List       ::=
              ( first-local-no  :       @lt{Local-Text-No};
                texts           :       @lt{ARRAY} @lt{Text-No};
              )
@end example

These three types are used to indicate articles in the LysKOM database.
@type{Text-No} is a global text number and @type{Local-Text-No} a local
text number.  @type{Text-List} is used when a mapping from local to
global numbers are required.

@anchor{Pers-No}
@anchor{Session-No}
@subsection Person and Session Numbers

@tindex Pers-No
@tindex Session-No
@example
        Pers-No         ::=     @lt{Conf-No};
        Session-No      ::=     @lt{INT32};
@end example

@type{Pers-No} is used to indicate a person.  @type{Session-No} is used
in a few data structures relating to information about active LysKOM
sessions.

@node Auxiliary Information
@section Auxiliary Information

@anchor{Aux-No}
@anchor{Aux-Item}
@anchor{Aux-Item-Input}
@anchor{Aux-Item-Flags}
@tindex Aux-No
@tindex Aux-Item
@tindex Aux-Item-Input
@tindex Aux-Item-Flags
@example
        Aux-No   ::=    @lt{INT32};

        Aux-Item ::=
              ( aux-no      :       @lt{Aux-No};
                tag         :       @lt{INT32};
                creator     :       @lt{Pers-No};
                created-at  :       @lt{Time};
                flags       :       @lt{Aux-Item-Flags};
                inherit-limit :     @lt{INT32};
                data        :       @lt{HOLLERITH};
              )

        Aux-Item-Input ::=
              ( tag         :       @lt{INT32};
                flags       :       @lt{Aux-Item-Flags};
                inherit-limit :     @lt{INT32};
                data        :       @lt{HOLLERITH};
              )

@need 2200
        Aux-Item-Flags ::= BITSTRING
              ( deleted;
                inherit;
                secret;
                hide-creator;
                dont-garb;
                reserved2;
                reserved3;
                reserved4;
              )
@end example

Aux-Item-Input contains a subset of the fields of an Aux-Item.  It is
used when the client wants to send an Aux-Item to the server, and it
only contains the elements that the client can affect.  The fields in
Aux-Item and Aux-Item-Input have the following meaning:

@table @field
@item aux-no
The number of the item within the list where it is found.  This number
together with a conference or text number uniquely identifies a
particular aux-item.  (There is also a global list of Aux-Items for
the server.  That list is manipulated via the
@reqdlink{modify-system-info} request@linkhere{}, and when using that request
the @field{aux-no} is enough to uniquely identify the aux-item.)

This field is not present in @type{Aux-Item-Input}.  It is assigned by
the server.
@item tag
The item tag.  The tag determines what the data means.  @xref{Aux-Item
Types}.

@item creator
The person who created the item, or zero if the item was created
anonymously or if the owner is being withheld.

This field is not present in @type{Aux-Item-Input}.  It is assigned by
the server.
@item created-at
The time when the item was created.

This field is not present in @type{Aux-Item-Input}.  It is assigned by
the server.
@item flags
The item flags (see below).
@item inherit-limit
Determines how many times (how deep) an item may be inherited.  If zero,
the item is inherited an unlimited number of times.  If nonzero it is
@emph{one more} than the number of additional times the item may be
inherited.  Thus, 1 means that inheritance will be blocked and 2 means
that the item will be inherited only to the next level.
@item data
The item data.
@end table

The flags that can be set on an aux-item have the following meaning:

@table @field
@item deleted
The item has been deleted, and should not be used for anything.
@item inherit
The item will be inherited (if the inherit-limit field allows it.)
@item secret
The item will not be revealed to anyone but the item's creator and
supervisors of the creator.
@item hide-creator
The item creator will be withheld from everyone but the item's creator
and supervisors of the creator.
@item dont-garb
The object the item is set on will not be garbage-collected.
@end table


@node Conference Types
@section Conference Types

@anchor{Conf-Type}
@anchor{Extended-Conf-Type}
@anchor{Any-Conf-Type}
@tindex Conf-Type
@tindex Extended-Conf-Type
@tindex Any-Conf-Type
@example
        Conf-Type ::= BITSTRING
              ( rd-prot;
                original;
                secret;
                letterbox;
              )

        Extended-Conf-Type ::=  BITSTRING
              ( rd-prot;
                original;
                secret;
                letterbox;
                allow-anonymous;
                forbid-secret;
                reserved2;
                reserved3;
              )

        Any-Conf-Type   ::=     @lt{Conf-Type} | @lt{Extended-Conf-Type};
@end example

These types are used to specify the type of a conference.
@type{Conf-Type} is used in data types and calls that were created
before version 8.0 of the protocol and has been augmented in
@type{Extended-Conf-Type}.  The type @type{Any-Conf-Type} is used when
either is admissible.

The bits have the following meaning (@pxref{Conferences}, for more
info.)

@table @conftype
@item rd-prot
If unset anyone can add themselves as members to the conference.

@item original
If set, comments are not allowed in the conference.

@item secret
If set the conference is secret.  It's existence will only be revealed to
members and supervisors.

@item letterbox
Set if the conference is a person's mailbox.

@item allow-anonymous
Set if anonymous articles are allowed in the conference.

@item forbid-secret
If set, secret members cannot be added to the conference.

@itemx reserved2
@itemx reserved3
Reserved for future use.  The values of these bits should be never be
modified or used by clients who do not know their meaning.  When a new
conference is created these should always be set to zero.
@end table


@node Conference Search Results
@section Conference Search Results

@anchor{Conf-Z-Info}
@tindex Conf-Z-Info
@example
        Conf-Z-Info ::=
              ( name    :       @lt{HOLLERITH};
                type    :       @lt{Conf-Type};
                conf-no :       @lt{Conf-No};
              )
@end example

These types are used for the result of some calls that search for
conferences based on their names.


@node Conference Status Types
@section Conference Status Types

@anchor{Garb-Nice}
@anchor{Conference-Old}
@tindex Garb-Nice
@tindex Conference-Old
@tindex Conference
@tindex UConference
@example
        Garb-Nice ::= @lt{INT32};

        Conference-Old ::=
                ( name                  :       @lt{HOLLERITH};
                  type                  :       @lt{Conf-Type};
                  creation-time         :       @lt{Time};
                  last-written          :       @lt{Time};
                  creator               :       @lt{Pers-No};
                  presentation          :       @lt{Text-No};
                  supervisor            :       @lt{Conf-No};
                  permitted-submitters  :       @lt{Conf-No};
                  super-conf            :       @lt{Conf-No};
                  msg-of-day            :       @lt{Text-No};
                  nice                  :       @lt{Garb-Nice};
                  no-of-members         :       @lt{INT16};
                  first-local-no        :       @lt{Local-Text-No};
                  no-of-texts           :       @lt{INT32};
                )

@anchor{Conference}
        Conference ::=
                ( name                  :       @lt{HOLLERITH};
                  type                  :       @lt{Extended-Conf-Type};
                  creation-time         :       @lt{Time};
                  last-written          :       @lt{Time};
                  creator               :       @lt{Pers-No};
                  presentation          :       @lt{Text-No};
                  supervisor            :       @lt{Conf-No};
                  permitted-submitters  :       @lt{Conf-No};
                  super-conf            :       @lt{Conf-No};
                  msg-of-day            :       @lt{Text-No};
                  nice                  :       @lt{Garb-Nice};
                  keep-commented        :       @lt{Garb-Nice};
                  no-of-members         :       @lt{INT16};
                  first-local-no        :       @lt{Local-Text-No};
                  no-of-texts           :       @lt{INT32};
                  expire                :       @lt{Garb-Nice};
                  aux-items             :       @lt{ARRAY} @lt{Aux-Item};
                )

@anchor{UConference}
        UConference ::=
                ( name                  :       @lt{HOLLERITH};
                  type                  :       @lt{Extended-Conf-Type};
                  highest-local-no      :       @lt{Local-Text-No};
                  nice                  :       @lt{Garb-Nice};
                )
@end example

These three types are used to specify information about a conference.
@type{Garb-Nice} is a quantity used to specify how long articled are
kept in a conference before being removed.  @type{Conference} is the full
information about a conference and @type{UConference} is brief
information about a conference.

The fields of @type{Conference} are

@table @field
@item name
The name of this conference.
@item type
The type of the conference.
@item creation-time
The date and time when the conference was created.
@item last-written
The date when something was last written in the conference.
@item creator
The person who created the conference.
@item presentation
The article containing the conference presentation or zero if the
conference has no presentation.
@item supervisor
The conference@footnote{The @field{supervisor} may be a person, in which
case the members of that person's mailbox become supervisors.} who
supervises this conference.
@item permitted-submitters
The conference whose members@footnote{@field{permitted-submitters} can be
a person, in which case all persons who are members of the associated
mailbox are allowed to submit articles to the conference.} may submit
articles to the conference, or zero if anyone may do so.
@item super-conf
This field has two unrelated uses.  If the @conftype{original} bit is
set, clients should send comments to this conference
(@pxref{Recipients of comments}).  If the @field{permitted-submitters}
field rejects a text@footnote{This is true if the text is created
using @reqlink{create-text}, @reqlink{create-anonymous-text},
@reqlink{create-anonymous-text-old} or @reqlink{create-text-old}.
Future requests that create texts may have other semantics.}, the
server will silently send the text to the @field{super-conf}
conference instead.  This redirection mechanism is applied repeatedly
until conference that accepts the text is found, or an
implementation-defined limit is reached.
@item msg-of-day
The conference notice, if any.
@item nice
The number of days an article should be kept before being removed from
the conference.
@item keep-commented
A text that has comments no older than this number of days will not be
removed from the conference.
@item no-of-members
The number of members of this conference.
@item first-local-no
The local number of the oldest existing article in the conference.
@item no-of-texts
The number of articles in the conference.
@item expire
This field will be used to control when a conference expires.
It is not used at the moment, and should be set to zero for future
compatibility.
@item aux-items
The conference's aux item list.
@end table

The fields of @type{UConference} are

@table @field
@item name
The name of this conference.
@item type
The conference type.  Note that this is an extended conference type,
unlike the type field of @type{Conference}.
@item highest-local-no
The local number of the newest article in the conference.
@item nice
The number of days an article should be kept before being removed from
the conference.
@end table

@node Archaic way to list conferences
@section Archaic way to list conferences

@anchor{Conf-List-Archaic}
The result of request number 12, lookup-name, cannot be expressed in the
grammar used in this document.  This is as close as it gets:

@tindex Conf-List-Archaic
@example
      Conf-List-Archaic ::=
           ( conf-nos    : @lt{ARRAY} @lt{Conf-No};
             conf-types  : @lt{ARRAY} @lt{Conf-Type}; ! Sans @var{n}; see below
           )
@end example

The two arrays @field{conf-nos} and @field{conf-types} are always the same
size.  For some obscure reason the size of the second array is not
actually transmitted.  See also the example in @ref{lookup-name}.


@node Mapping Local to Global Text Numbers
@section Mapping Local to Global Text Numbers

@anchor{Text-Mapping}
@tindex Text-Mapping
@tindex Local-To-Global-Block
@tindex Text-Number-Pair
@example
        Text-Mapping ::=
              ( range-begin           :    @lt{Local-Text-No};
                range-end             :    @lt{Local-Text-No};
                more-texts-exists     :    @lt{BOOL};
                block                 :    @lt{Local-To-Global-Block};
              )

@anchor{Local-To-Global-Block}
        Local-To-Global-Block ::= SELECTION
              ( 0=sparse sparse-block :   @lt{ARRAY} @lt{Text-Number-Pair};
                1=dense  dense-block  :   @lt{Text-List};
              )

@anchor{Text-Number-Pair}
        Text-Number-Pair ::=
              ( local-number          :   @lt{Local-Text-No};
                global-number         :   @lt{Text-No};
              )
@end example

A @type{Text-Mapping} is used when the client needs to look up which
global @type{Text-No} that corresponds to a @type{Local-Text-No}.  The
client uses @reqlink{local-to-global} to ask for information about a few
texts starting a a certain local text number, and the server returns the
information in a @type{Text-Mapping}.

@table @field
@item range-begin
The first local text number that the @type{Text-Mapping} says anything
about.

@item range-end
The first local text number that the reply doesn't say anything about.
This @type{Text-Mapping} tells the client about all existing texts from
@field{range-begin} to (but not including) @field{range-end}.

@item more-texts-exists
This is true if there are more texts in the conference after this
block.  If a request such as @reqlink{local-to-global-reverse} which
searches backwards, this will instead be true if there are more texts
before this block.

@item block
The block can be sent i two formats.  The server is free to choose which
format to use as it pleases; clients must be prepared for any of them.
@itemize @bullet

@item
The @dfn{sparse} format is useful when many local text number no longer
exists.  It starts with a @code{0} that indicates that the sparse format
is used, and is followed by an array of @type{Text-Number-Pair}.  The
array will always be sorted so that @field{local-number} always
increases.

@item
The @dfn{dense} format is good when most of the local text numbers
exist.  It starts with a @code{1} that indicates that the dense format
is used, and is followed by a @type{Text-List}.  The @type{Text-List}
contains @field{first-local-no} and an array of @type{Text-No}.
The local text number @field{first-local-no} corresponds to the first
@type{Text-No} in the array, @field{first-local-no} + 1 corresponds to
the second entry in the array, and so on.  The array contains a zero to
indicate that a certain local text number doesn't exist.

@end itemize
@end table


@node Server Information
@section Server Information

@anchor{Info}
@tindex Info
@tindex Info-Old
@tindex Version-Info
@tindex Static-Server-Info
@example
        Info ::=
              ( version             :   @lt{INT32};
                conf-pres-conf      :   @lt{Conf-No};
                pers-pres-conf      :   @lt{Conf-No};
                motd-conf           :   @lt{Conf-No};
                kom-news-conf       :   @lt{Conf-No};
                motd-of-lyskom      :   @lt{Text-No};
                aux-item-list       :   @lt{ARRAY} @lt{Aux-Item};
              )

@anchor{Info-Old}
        Info-Old ::=
              ( version             :   @lt{INT32};
                conf-pres-conf      :   @lt{Conf-No};
                pers-pres-conf      :   @lt{Conf-No};
                motd-conf           :   @lt{Conf-No};
                kom-news-conf       :   @lt{Conf-No};
                motd-of-lyskom      :   @lt{Text-No};
              )

@anchor{Version-Info}
        Version-Info ::=
              ( protocol-version    :   @lt{INT32};
                server-software     :   @lt{HOLLERITH};
                software-version    :   @lt{HOLLERITH};
              )

@anchor{Static-Server-Info}
        Static-Server-Info ::=
              ( boot-time           :   @lt{Time};
                save-time           :   @lt{Time};
                db-status           :   @lt{HOLLERITH};
                existing-texts      :   @lt{INT32};
                highest-text-no     :   @lt{Text-No};
                existing-confs      :   @lt{INT32};
                existing-persons    :   @lt{INT32};
                highest-conf-no     :   @lt{Conf-No};
              )
@end example

These data types contain information about the LysKOM server.  The fields
of @type{Info} and @type{Info-Old} are:

@table @field
@item version
The server version encoded as a number
@var{@badspell{aa}}@var{@badspell{bb}}@var{@badspell{cc}} where
@var{@badspell{aa}} is the major version number, @var{@badspell{bb}}
the minor number and @var{@badspell{cc}} the secondary minor version.
For instance, @code{10607} is
version 1.6.7 of the server.  If greater than 10699 the
@reqlink{get-version-info} should be used instead.
@item conf-pres-conf
The conference that contains conference presentations.
@item pers-pres-conf
The conference that contains person presentations.
@item motd-conf
The conference that contains conference and person notices.
@item kom-news-conf
The conference that contains news about LysKOM.
@item motd-of-lyskom
The number of an article to display when LysKOM is entered or zero if
there is none.
@item aux-item-list
(Not present in @type{Info-Old}.)  A list of aux-items that belong to
the server.
@end table

The fields of @type{Version-Info} are:

@table @field
@item protocol-version
The version of protocol A the server is using.  This may be used to
ascertain which calls are available.
@item server-software
Human-readable name of the server software.
@item software-version
Human-readable name of the server software version.
@end table

The @type{Static-Server-Info} contains information about the state of
the server when it started.  It contains the following fields:

@table @field
@item boot-time
When did the server start?

@item save-time
When the server starts, it examines the database to see when it was
saved.  That information is available here.

@item db-status
The status of the database that the server found on startup.  The
value is implementation-defined.  lyskomd reports @code{clean} (if the
previous invocation of the server was shut down cleanly) or
@code{backup} (which means that some information may have been lost in
the last restart).  Clients should be prepared to find other values
here.

@item existing-texts
Number of texts that existed on startup.  (To find out how many texts
exists right now, you can use the @reqdlink{get-stats} call with
@code{what} set to @code{texts}@linkhere{}.)

@item highest-text-no
The highest text number that existed on startup.  (To find the highest
text number that exists right now, use the
@reqlink{first-unused-text-no} and @reqlink{find-previous-text-no}
calls.)

@item existing-confs
Number of conferences (including letterboxes) that existed on startup.
(To find out how many conferences exists right now, you can use the
@reqdlink{get-stats} call with @code{what} set to
@code{confs}@linkhere{}.)

@item existing-persons
Number of persons that existed on startup.  (To find out how many
persons exists right now, you can use the @reqdlink{get-stats} call
with @code{what} set to @code{persons}@linkhere{}.)

@item highest-conf-no
The highest conference number that existed on startup.  (To find the
highest conference number that exists right now, use the
@reqlink{first-unused-conf-no} and @reqlink{find-previous-conf-no}
calls.)

@end table

@node Person Status Types
@section Person Status Types

@anchor{Person}
@tindex Person
@tindex Personal-Flags
@tindex Priv-Bits
@example
        Person ::=
              ( username                :       @lt{HOLLERITH};
                privileges              :       @lt{Priv-Bits};
                flags                   :       @lt{Personal-Flags};
                last-login              :       @lt{Time};
                user-area               :       @lt{Text-No};
                total-time-present      :       @lt{INT32};
                sessions                :       @lt{INT32};
                created-lines           :       @lt{INT32};
                created-bytes           :       @lt{INT32};
                read-texts              :       @lt{INT32};
                no-of-text-fetches      :       @lt{INT32};
                created-persons         :       @lt{INT16};
                created-confs           :       @lt{INT16};
                first-created-local-no  :       @lt{INT32};
                no-of-created-texts     :       @lt{INT32};
                no-of-marks             :       @lt{INT16};
                no-of-confs             :       @lt{INT16};
              )

@anchor{Personal-Flags}
        Personal-Flags ::= BITSTRING
              ( unread-is-secret;
                flg2;
                flg3;
                flg4;
                flg5;
                flg6;
                flg7;
                flg8;
              )


@anchor{Priv-Bits}
        Priv-Bits ::= BITSTRING
              ( wheel;
                admin;
                statistic;
                create-pers;
                create-conf;
                change-name;
                flg7;
                flg8;
                flg9;
                flg10;
                flg11;
                flg12;
                flg13;
                flg14;
                flg15;
                flg16;
              )
@end example

These types are used to specify information about persons.  @type{Person}
contains the information about a person, @type{Personal-Flags} contains
flags set by the user and @type{Priv-Bits} contains the person's
privileges (@pxref{Security}).

The fields of @type{Person} are

@table @field
@item username
The name of the user.
@c FIXME (bug 196): this is wrong/needs explanation/should be renamed.
@item privileges
The privileges of the person.
@item flags
Flags set by the user.
@item last-login
The time when the person last logged on or off.
@item user-area
The text number of the person's user area or zero if the person has no
user area.
@item total-time-present
The number of seconds the person has been using LysKOM.
@item sessions
The number of sessions the person has initiated.
@item created-lines
The number of lines of articles the person has written.
@item created-bytes
The number of characters the person has written.
@item read-texts
The number of articles the person has read.
@item no-of-text-fetches
The number of texts the person has retrieved from the server.
@item created-persons
The number of other persons this person has created.
@item created-confs
This holds the number of conferences created by the person.
@item first-created-local-no
The local number of the earliest existing article written by the person.
The local number applies to a local-to-global mapping containing all
articles written by the person.
@item no-of-created-texts
This holds the number of articles written by the person, not counting
the articles created before the earliest existing article written by
the person.  To get the true number of created articles, compute
@field{first-created-local-no} + @field{no-of-created-texts} - 1.
@item no-of-marks
The number of marked texts this person has.
@item no-of-confs
The number of conferences the person is a member of.
@end table

The fields of @type{Personal-Flags} are

@table @field
@item unread-is-secret
If this is set, only the person and his supervisors can see how many
texts this persons have read in a certain conference.  The server will
clear the @field{read-ranges} field of @type{Membership} (and
@field{read-texts}, @field{last-time-read} and @field{last-text-read}
fields of @type{Membership-10} and @type{Membership-Old}) when other
persons asks about the information.

@item flg2
@itemx flg3
@itemx flg4
@itemx flg5
@itemx flg6
@itemx flg7
@itemx flg8
Reserved for the future.  Set them to 0, and ignore the values they
have.
@end table

@node Membership Information
@section Membership Information

@anchor{Membership-Type}
@tindex Membership-Type
@example
        Membership-Type ::=     BITSTRING
              ( invitation;
                passive;
                secret;
                passive-message-invert;
                reserved2;
                reserved3;
                reserved4;
                reserved5;
              )
@end example

The @type{Membership-Type} type contains flags that modify a membership.
It is passed as part of both @type{Member} and @type{Membership} (and
obsolete versions of those types).
The flags are:

@table @field
@item invitation
The member has been invited, but has not yet accepted membership.
Clients should set this flag when adding other users as members.  The
server may force this flag to be set when adding another person as a
member of a conference.

@item passive
The member is not actively participating in the conference.  Passive
members do not receive messages (@pxref{async-send-message}) and
should not be displayed as active members by clients.  See also
@field{passive-message-invert}.

@item secret
The member does not wish to disclose the membership.  Secret memberships
and members are cleared before being returned to a person who is not a
supervisor of the member or has sufficient privileges enabled.

@item passive-message-invert
If this bit is set, the @field{passive} bit is inverted when checking
for messages (@pxref{async-send-message}) to this conference.  In
other words, messages are blocked if one (but not both) of the bits
@field{passive} and @field{passive-message-invert} are set.

@end table

The remaining flags in the @type{Membership-Type} structure are reserved
and should be set to false on all new memberships and retained on all
existing memberships.

@anchor{Member}
@tindex Member
@example
        Member          ::=
              ( member          :       @lt{Pers-No};
                added-by        :       @lt{Pers-No};
                added-at        :       @lt{Time};
                type            :       @lt{Membership-Type};
              )
@end example

The @type{Member} structure encodes information about a member in a
conference.  It is returned by the @reqdlink{get-members} call@linkhere{}.  The
fields of a @type{Member} structure are

@table @field
@item member
The person who is a member of the conference.
@item added-by
The person who created the membership.  This field is zero only if the
membership was created before protocol version 10 was introduced.
@item added-at
The time when the membership was created.  This field is meaningless if
added-by is zero.
@item type
Flags modifying the membership.
@end table

The contents of a @type{Member} structure can be cleared (all fields set
to zero) if the person requesting the record has insufficient privileges
to see the contents of the structure.


@anchor{Membership}
@anchor{Read-Range}
@tindex Membership-Old
@tindex Membership
@tindex Read-Range
@tindex Membership-10
@example
        Read-Range ::=
              ( first-read      :       @lt{Local-Text-No};
                last-read       :       @lt{Local-Text-No};
              )

        Membership ::=
              ( position        :       @lt{INT32};
                last-time-read  :       @lt{Time};
                conference      :       @lt{Conf-No};
                priority        :       @lt{INT8};
                read-ranges     :       @lt{ARRAY} @lt{Read-Range};
                added-by        :       @lt{Pers-No};
                added-at        :       @lt{Time};
                type            :       @lt{Membership-Type};
              )
@anchor{Membership-Old}
        Membership-Old ::=
              ( last-time-read  :       @lt{Time};
                conference      :       @lt{Conf-No};
                priority        :       @lt{INT8};
                last-text-read  :       @lt{Local-Text-No};
                read-texts      :       @lt{ARRAY} @lt{Local-Text-No};
              )

@anchor{Membership-10}
        Membership-10 ::=
              ( position        :       @lt{INT32};
                last-time-read  :       @lt{Time};
                conference      :       @lt{Conf-No};
                priority        :       @lt{INT8};
                last-text-read  :       @lt{Local-Text-No};
                read-texts      :       @lt{ARRAY} @lt{Local-Text-No};
                added-by        :       @lt{Pers-No};
                added-at        :       @lt{Time};
                type            :       @lt{Membership-Type};
              )
@end example

The @type{Membership} structure encodes information about a person's
membership in a conference.  It is returned by the
@reqlink{query-read-texts} and @reqdlink{get-membership} calls@linkhere{}.

The @type{Membership-10} and @type{Membership-Old} types are obsolete
variants of the same type, returned by older requests.
@type{Membership-Old} contains less information.  The encoding of the
read texts in @type{Membership-10} is very inefficient in the common
case where you have read many texts after the first unread text.

@table @field
@item position
The position of this membership in the membership list.
@item last-time-read
The time when the person last read anything from the conference.  This
will contain the start of the epoch if the @field{unread-is-secret}
bit of the @type{Personal-Flags} is set and you don't have enough
privileges to get the info anyhow.
@item conference
The conference this membership data pertains to.
@item priority
The priority the person has assigned to the conference.  The higher the
number, the higher the priority.  In the past, priority zero indicated a
passive membership.  This usage is now obsolete.
@item last-text-read
The local number of last text read in the conference.  This will be
set to 0 if @field{unread-is-secret} is set, unless you have access to
the data anyhow.  This field is not available in @type{Membership},
but you can easily derive the same information from
@field{read-ranges}.
@item read-texts
Additional texts beyond @field{last-text-read} that have also been
read.  This will be empty if @field{unread-is-secret} is set, unless
you have access to the data anyhow.
@item read-ranges
A list of ranges of all read texts.  This will be empty if
@field{unread-is-secret} is set, unless you have access to the data
anyhow.
@item added-by
The person who created the membership.  This field is zero if the
membership was created before protocol version 10 was introduced.
@item added-at
The time when the membership was created.  This field is meaningless if
added-by is zero.
@item type
Flags modifying the membership.
@end table

A membership record may be cleared by the server (all fields set to
zero) if the person requesting the membership has insufficient
privileges to see the contents membership, but has sufficient privileges
to know about the person.


@node Article Marks
@section Article Marks

@anchor{Mark}
@tindex Mark
@example
        Mark ::=
                ( text-no       :       @lt{Text-No};
                  type          :       @lt{INT8};
                )
@end example

This data type hold information about a person's marks on articles.

The fields of @type{Mark} are

@table @field
@item text-no
The text number marked.
@item type
The mark value.
@end table

Before version eight of protocol A, the meaning of the mark value was
unspecified.  Work is underway to specify the meaning of certain mark
values.


@node Article Information
@section Article Information

@anchor{Misc-Info}
@tindex Misc-Info
@tindex Text-Stat-Old
@tindex Text-Stat
@tindex Info-Type
@example
        Misc-Info ::= SELECTION
                ( 0=recpt       recipient       :       @lt{Conf-No};
                  1=cc-recpt    cc-recipient    :       @lt{Conf-No};
                  2=comm-to     comment-to      :       @lt{Text-No};
                  3=comm-in     commented-in    :       @lt{Text-No};
                  4=footn-to    footnote-to     :       @lt{Text-No};
                  5=footn-in    footnoted-in    :       @lt{Text-No};
                  6=loc-no      local-no        :       @lt{Local-Text-No};
                  7=rec-time    received-at     :       @lt{Time};
                  8=sent-by     sender          :       @lt{Pers-No};
                  9=sent-at     sent-at         :       @lt{Time};
                 15=bcc-recpt   bcc-recipient   :       @lt{Conf-No};
               )

@anchor{Info-Type}
        Info-Type ::= ENUMERATION-OF(@lt{Misc-Info})

@anchor{Text-Stat-Old}
        Text-Stat-Old ::=
              ( creation-time   :       @lt{Time};
                author          :       @lt{Pers-No};
                no-of-lines     :       @lt{INT32};
                no-of-chars     :       @lt{INT32};
                no-of-marks     :       @lt{INT16};
                misc-info       :       @lt{ARRAY} @lt{Misc-Info};
              )

@anchor{Text-Stat}
        Text-Stat ::=
              ( creation-time   :       @lt{Time};
                author          :       @lt{Pers-No};
                no-of-lines     :       @lt{INT32};
                no-of-chars     :       @lt{INT32};
                no-of-marks     :       @lt{INT16};
                misc-info       :       @lt{ARRAY} @lt{Misc-Info};
                aux-items       :       @lt{ARRAY} @lt{Aux-Item};
              )

@end example

These two structures contain information about a single article.
@type{Text-Stat} contains core information about the article and
@type{Misc-Info} contains miscellaneous information related to the
article.

A @type{Text-Stat} consists of the following:

@table @field
@item creation-time
The time when the article was created.
@item author
The author of the article.
@item no-of-lines
The number of lines in the article.
@item no-of-chars
The number of characters in the article.
@item no-of-marks
The number of marks added to this article by persons.
@item misc-info
The @type{Misc-Info} list for this article.
@item aux-items
The list of aux items for this article.
@end table

@type{Misc-Info}, when sent to the client, is sent in a particular order
(@pxref{The Misc-Info List}).  The variants @type{Misc-Info} are
(briefly):

@table @misc
@item recpt
Used to specify recipients of the article.
@item cc-recpt
Specifies recipients who have received a copy of the article but who
will not receive comments.
@item comm-to
Specifies an article this article is a comment to.
@item comm-in
Specifies an article in which there are comments to this article.
@item footn-to
Specifies an article this article is a footnote to.
@item footn-in
Specifies an article to which this article is a footnote.
@item loc-no
Specifies the local text number of this article in the conference
specified by @misc{recpt}, @misc{cc-recpt} or @misc{bcc-recpt}.
@item rec-time
Specifies the time when this article was received by the conference
specified by @misc{recpt}, @misc{cc-recpt} or @misc{bcc-recpt}.
@item sent-by
Specifies who sent this article to the conference specified by
@misc{recpt}, @misc{cc-recpt} or @misc{bcc-recpt}.
@item sent-at
Specifies when the article was sent to the conference specified by
@misc{recpt}, @misc{cc-recpt} or @misc{bcc-recpt}.
@item bcc-recpt
Specifies a blind carbon copy recipient.  This item is only accepted by
protocol version 10 servers and is only sent in responses and messages
introduced in protocol version 10 or later.
@end table


@node Who Information
@section Who Information

@anchor{Who-Info-Old}
@anchor{Who-Info}
@anchor{Who-Info-Ident}
@tindex Who-Info-Old
@tindex Who-Info
@tindex Who-Info-Ident
@example
        Who-Info-Old ::=
              ( person                  :       @lt{Pers-No};
                working-conference      :       @lt{Conf-No};
                what-am-i-doing         :       @lt{HOLLERITH};
              )

        Who-Info ::=
              ( person                  :       @lt{Pers-No};
                working-conference      :       @lt{Conf-No};
                session                 :       @lt{Session-No};
                what-am-i-doing         :       @lt{HOLLERITH};
                username                :       @lt{HOLLERITH};
              )

        Who-Info-Ident ::=
              ( person                  :       @lt{Pers-No};
                working-conference      :       @lt{Conf-No};
                session                 :       @lt{Session-No};
                what-am-i-doing         :       @lt{HOLLERITH};
                username                :       @lt{HOLLERITH};
                hostname                :       @lt{HOLLERITH};
                ident-user              :       @lt{HOLLERITH};
              )
@end example

These structures are used to retrieve information on who is currently
using LysKOM.  All the requests using these types are obsolete, but
@type{Who-Info} is used by @async{async-i-am-on}
(@pxref{async-i-am-on}).


The fields of @type{Who-Info-Old} are
@table @field
@item person
The person the information is about.
@item working-conference
The conference the person is currently in.
@item what-am-i-doing
A client-supplied string saying what the person is doing.
@end table

The fields of @type{Who-Info} are
@table @field
@item person
The person the information is about.
@item working-conference
The conference the person is currently in.
@item session
The person's session number.
@item what-am-i-doing
A client-supplied string saying what the person is doing.
@item username
The name of the ``real'' user constructed from @field{hostname} and
@field{ident-user} (see below) and information from the client.
@c FIXME (bug 196): define the format
@end table



The fields of @type{Who-Info-Ident} are
@table @field
@item person
The person the information is about.
@item working-conference
The conference the person is currently in.
@item session
The person's session number.
@item what-am-i-doing
A client-supplied string saying what the person is doing.
@item username
The name of the ``real'' user constructed from @field{hostname} and
@field{ident-user}.
@c FIXME (bug 196): define the format
@item hostname
The host the connection originated at.
@item ident-user
The user name according to the Ident @daemon{}
at the user's machine or ``unknown'' if Ident was not used.
@end table



@node Session Information
@section Session Information

@anchor{Session-Info}
@anchor{Session-Info-Ident}
@tindex Session-Info
@tindex Session-Info-Ident
@tindex Static-Session-Info
@tindex Session-Flags
@tindex Dynamic-Session-Info
@tindex Scheduling-Info
@example
        Session-Info ::=
              ( person                  :       @lt{Pers-No};
                working-conference      :       @lt{Conf-No};
                session                 :       @lt{Session-No};
                what-am-i-doing         :       @lt{HOLLERITH};
                username                :       @lt{HOLLERITH};
                idle-time               :       @lt{INT32};
                connection-time         :       @lt{Time};
              )

        Session-Info-Ident ::=
              ( person                  :       @lt{Pers-No};
                working-conference      :       @lt{Conf-No};
                session                 :       @lt{Session-No};
                what-am-i-doing         :       @lt{HOLLERITH};
                username                :       @lt{HOLLERITH};
                hostname                :       @lt{HOLLERITH};
                ident-user              :       @lt{HOLLERITH};
                idle-time               :       @lt{INT32};
                connection-time         :       @lt{Time};
              )

@anchor{Static-Session-Info}
        Static-Session-Info ::=
              (
                username                : @lt{HOLLERITH};
                hostname                : @lt{HOLLERITH};
                ident-user              : @lt{HOLLERITH};
                connection-time         : @lt{Time};
              )

@anchor{Session-Flags}
        Session-Flags ::= BITSTRING
              ( invisible;
                user-active-used;
                user-absent;
                reserved3;
                reserved4;
                reserved5;
                reserved6;
                reserved7;
              )

@anchor{Dynamic-Session-Info}
        Dynamic-Session-Info ::=
              ( session                 :       @lt{Session-No};
                person                  :       @lt{Pers-No};
                working-conference      :       @lt{Conf-No};
                idle-time               :       @lt{INT32};
                flags                   :       @lt{Session-Flags};
                what-am-i-doing         :       @lt{HOLLERITH};
              )

@anchor{Scheduling-Info}
        Scheduling-Info ::=
              ( priority                : @lt{INT16};
                weight                  : @lt{INT16};
              )
@end example

These data types give information about a particular LysKOM session.  The
types @type{Session-Info} and @type{Session-Info-Ident} have been
superseded by @type{Static-Session-Info} and
@type{Dynamic-Session-Info}.  The static session info represents
information about a session that does not change during the lifetime of
the session.  Therefore static session infos can be aggressively cached by
the client.

The fields of @type{Session-Info} are
@table @field
@item person
The person using this session.
@item working-conference
The conference the session is currently in.
@item session
The number of this session.
@item what-am-i-doing
A client-supplied string saying what the person is currently doing.
@item username
The name of the ``real'' user (see @type{Who-Info} above.)
@item idle-time
The number of seconds since @reqdlink{user-active} was used by this
session@linkhere{}, or since the session was created if
@req{user-active} has not been used yet.  See also
@field{user-active-used} below.
@item connection-time
The time when the connection was initiated.  This is not the same as the
amount of time the person has been on.
@end table

The fields of @type{Session-Info-Ident} are
@table @field
@item person
The person using this session.
@item working-conference
The conference the session is currently in.
@item session
The number of this session.
@item what-am-i-doing
A client-supplied string saying what the person is currently doing.
@item username
The name of the ``real'' user (see @type{Who-Info-Ident} above.)
@item hostname
The host the connection originated at.
@item ident-user
The user name according to the Ident @daemon{}
at the user's machine or ``unknown''
if Ident was not used.
@item idle-time
The number of seconds since @reqdlink{user-active} was used by this
session@linkhere{}, or since the session was created if
@req{user-active} has not been used yet.  See also
@field{user-active-used} below.
@item connection-time
The time when the connection was initiated.  This is not the same as the
amount of time the person has been on.
@end table

The fields of @type{Static-Session-Info} are

@table @field
@item username
The name of the ``real'' user (see @type{Who-Info-Ident} above.)
@item hostname
The host the connection originated at.
@item ident-user
The user name according to the Ident @daemon{}
at the user's machine or ``unknown''
if Ident was not used.
@item connection-time
The time when the connection was initiated.  This is not the same as the
amount of time the person has been on.
@end table

The bits in @type{Session-Flags} are:

@table @field
@item invisible
When true, the user requested an invisible session (@pxref{login}).
Sessions where no-one is logged in also have the @field{invisible} flag
set.
@item user-active-used
When true, the @reqdlink{user-active} call@linkhere{} has been issued by
the session, which in turn means that @field{idle-time} fields of
@type{Dynamic-Session-Info}, @type{Session-Info} and
@type{Session-Info-Ident} are valid.  When false, the
@field{idle-time} fields contains the number of seconds since the
session was created.
@item user-absent
This flag is currently not used.
@end table

The fields of a @type{Dynamic-Session-Info} are

@table @field
@item session
The session number of the session.
@item person
The person currently logged on, or zero if the session has not yet
logged on.
@item working-conference
The conference the session is currently in.
@item idle-time
The number of seconds since @reqdlink{user-active} was used by this
session@linkhere{}, or since the session was created if
@req{user-active} has not been used yet.  See also
@field{user-active-used} above.
@item flags
The dynamic session flags (see above.)
@item what-am-i-doing
What the client is doing.  This string is set by the client.
@end table

The @type{Scheduling-Info} type determines how the resources are
shared between different sessions@footnote{RFC 2782 (DNS SRV) provided
inspiration when the @type{Scheduling-Info} structure was defined.}.
See @reqlink{get-scheduling} and @reqlink{set-scheduling} for more
information.  It contains these fields:

@table @field
@item priority
Clients with a numerically lower @field{priority} value will have
priority over other clients.  A client with @field{priority} set to 0
can totally starve clients with @field{priority} set to 1, 2 or
anything higher.

@item weight
Within a priority class, the resources are shared in proportion to the
@field{weight} value.  If one client has a weight of 200 and another of
50, the first client will get roughly four times as much work done
(assuming that the server is the limiting factor).

@end table

@node Statistics
@section Statistics

@anchor{Stats}
@anchor{Stats-Description}
@tindex Stats
@tindex Stats-Description
@example
        Stats ::=
              ( average      : @lt{FLOAT};
                ascent-rate  : @lt{FLOAT};
                descent-rate : @lt{FLOAT};
              )

        Stats-Description ::=
              ( what : @lt{ARRAY} @lt{HOLLERITH};
                when : @lt{ARRAY} @lt{INT32};
              )
@end example

The @type{Stats} structure returns information about a measured value.

@table @field
@item average
The @field{average} is the average value for the measurement period.
If the measurement period is 0, this is instead the current value.

@item ascent-rate
@itemx descent-rate
These fields indicate the activity for this value, measured in units
per second.  If the measured value is pending DNS requests, the
@field{ascent-rate} would be the average number of issued requests per
second, and the @field{descent-rate} would be the average number of
received replies (or timeouts, errors, or other reasons why the
request is no longer pending).

When calculating the @field{ascent-rate}, only events that cause the
value to increase are considered.  Likewise, the @field{descent-rate}
only considers events that decrease the value.

Example: if the measurement period is 60 seconds, the value starts at
5, and it is increased by one 90 times and decreased by one 60 times
during the measurement period, the value will of course be 35 when the
period ends.  The ascent rate will be 1.5 per second, and the descent
rate 1.0 per second.

If the measurement period is 0, both @field{ascent-rate} and
@field{descent-rate} are set to 0.

@end table

The @type{Stats-Description} structure returns information about what
kind of statistical information that the server gathers.  It contains
these fields:

@table @field
@item what
A list of all things that the server collect statistics about.
@ref{Measured Properties}, for a list of things that might be included
in this list.

@item when
The statistics returned by @reqlink{get-stats} is a number of values
collected during various periods of time.  This array contains the
periods, measured in seconds.  The value 0 means that the current
value is returned.  The values are only returned in ascending order,
so if 0 is included it will be the first value.  @ref{Measured
Properties}, for more info.

@end table


@node Protocol Requests
@chapter Protocol Requests

This chapter documents all calls that can be made to the server.  All
calls are annotated with the protocol version in which they appeared and
their current status.

@menu
* Protocol Notation::           The notation used when describing the
                                  requests and their replies.
* login-old::                   O Log in to LysKOM. Call 62 is preferred    (0)
* logout::                      r Log out. Call 62 to log in again          (1)
* change-conference::           r Change current conference                 (2)
* change-name::                 r Change name of a conference or person     (3)
* change-what-i-am-doing::      r Change what-am-i-doing in who information (4)
* create-person-old::           O Create a person                           (5)
* get-person-stat-old::         O Get person information. Use call 49       (6)
* set-priv-bits::               r Set privileges of a person                (7)
* set-passwd::                  r Set password of a person                  (8)
* query-read-texts-old::        O Get info on what is read                  (9)
* create-conf-old::             O Create a conference                      (10)
* delete-conf::                 r Delete a conference                      (11)
* lookup-name::                 O Look up a name. Replaced by call 76      (12)
* get-conf-stat-older::         O Get conference information. Use call 50  (13)
* add-member-old::              O Add a member to a conference             (14)
* sub-member::                  r Remove a member from a conference        (15)
* set-presentation::            r Set the presentation of a conference     (16)
* set-etc-motd::                r Set conference notice                    (17)
* set-supervisor::              r Set supervisor of a conference           (18)
* set-permitted-submitters::    r Set permitted submitters of a conference (19)
* set-super-conf::              r Set super-conference of a conference     (20)
* set-conf-type::               r Set the type of a conference             (21)
* set-garb-nice::               r Set garb-nice of a conference            (22)
* get-marks::                   r Get marks for a person                   (23)
* mark-text-old::               O Mark a text. Replaced by calls 72 and 73 (24)
* get-text::                    r Get an article or part of an article     (25)
* get-text-stat-old::           O Get text status information              (26)
* mark-as-read::                r Mark an article as read in a conference  (27)
* create-text-old::             O Create an article                        (28)
* delete-text::                 r Delete an article                        (29)
* add-recipient::               r Add a recipient to an article            (30)
* sub-recipient::               r Remove a recipient from an article       (31)
* add-comment::                 r Add a comment to an article              (32)
* sub-comment::                 r Remove a comment from an article         (33)
* get-map::                     O Map local text nos to global. Use 103    (34)
* get-time::                    r Get the current time                     (35)
* get-info-old::                O Get server information                   (36)
* add-footnote::                r Add an article as a footnote to another  (37)
* sub-footnote::                r Remove a footnote from an article        (38)
* who-is-on-old::               O Get active sessions. Replaced by call 63 (39)
* set-unread::                  r Set number of unread in a conference     (40)
* set-motd-of-lyskom::          r Set LysKOM message of the day            (41)
* enable::                      r Set security level                       (42)
* sync-kom::                    r Save the database                        (43)
* shutdown-kom::                r Shut LysKOM down                         (44)
* broadcast::                   O Broadcast a message. Replaced by call 53 (45)
* get-membership-old::          O Get membership for a person. Use call 99 (46)
* get-created-texts::           O Get texts created by a user. Use 104     (47)
* get-members-old::             O Get members of a conference. Use 101     (48)
* get-person-stat::             r Get status information for a person      (49)
* get-conf-stat-old::           O Get status information for a conference  (50)
* who-is-on::                   O Get current sessions.  Use call 63       (51)
* get-unread-confs::            r Get conferences with unread articles     (52)
* send-message::                r Send a personal message                  (53)
* get-session-info::            O Get session information. Use call 64     (54)
* disconnect::                  r Disconnect a session                     (55)
* who-am-i::                    r Get current session number               (56)
* set-user-area::               r Set a person's user area                 (57)
* get-last-text::               r Get text created before a certain time   (58)
* create-anonymous-text-old::   O Create an anonymous text                 (59)
* find-next-text-no::           r Get next text number                     (60)
* find-previous-text-no::       r Get previous text number                 (61)
* login::                       r Log in to LysKOM                         (62)
* who-is-on-ident::             O Get current sessions                     (63)
* get-session-info-ident::      O Get session information                  (64)
* re-lookup-person::            O Look up a person based on name           (65)
* re-lookup-conf::              O Look up a conference based on name       (66)
* lookup-person::               O Find persons matching abbreviated name   (67)
* lookup-conf::                 O Find conference matching abbrev'd name   (68)
* set-client-version::          r Set the name and version the client      (69)
* get-client-name::             r Get the name of the client               (70)
* get-client-version::          r Get the version of the client            (71)
* mark-text::                   r Mark a text                              (72)
* unmark-text::                 r Unmark a text                            (73)
* re-z-lookup::                 r Lookup for conferences and persons       (74)
* get-version-info::            r Get protocol version of server           (75)
* lookup-z-name::               r Look up an abbreviated name              (76)
* set-last-read::               r Set text last read in a conference       (77)
* get-uconf-stat::              r Get abbreviated conference status        (78)
* set-info::                    r Set server information                   (79)
* accept-async::                r Select asynchronous messages to receive  (80)
* query-async::                 r Ask server which async messages are sent (81)
* user-active::                 r Tell the server that the user is active  (82)
* who-is-on-dynamic::           r Get a list of active users               (83)
* get-static-session-info::     r Get static information about a session   (84)
* get-collate-table::           r Get the current collate table            (85)
* create-text::                 r Create a text                            (86)
* create-anonymous-text::       r Create an anonymous text                 (87)
* create-conf::                 r Create a conference                      (88)
* create-person::               r Create a person                          (89)
* get-text-stat::               r Get text status information              (90)
* get-conf-stat::               r Get conference status information        (91)
* modify-text-info::            r Add or delete text aux items             (92)
* modify-conf-info::            r Add or delete conference aux items       (93)
* get-info::                    r Get server information                   (94)
* modify-system-info::          r Add or delete system aux items           (95)
* query-predefined-aux-items::  r Get list of aux-items the server knows   (96)
* set-expire::                  e Set the expire field of a conference     (97)
* query-read-texts-10::         O Get info on what is read                 (98)
* get-membership-10::           O Get membership for a person              (99)
* add-member::                  r Add a member to a conference            (100)
* get-members::                 r Get members of a conference             (101)
* set-membership-type::         r Modify the type of conference           (102)
* local-to-global::             r Map local text numbers to global ones   (103)
* map-created-texts::           r Map texts created by a person to global (104)
* set-keep-commented::          r Set how new comments protect old texts  (105)
* set-pers-flags::              r Set personal flags                      (106)
* query-read-texts::            r Get info on what is read                (107)
* get-membership::              r Get membership for a person             (108)
* mark-as-unread::              r Mark a text as not read                 (109)
* set-read-ranges::             r Specify which texts that are read       (110)
* get-stats-description::       r Get a list of measured properties       (111)
* get-stats::                   r Get a measurement                       (112)
* get-boottime-info::           r Get server startup status information   (113)
* first-unused-conf-no::        r Get first unused conference number      (114)
* first-unused-text-no::        r Get first unused text number            (115)
* find-next-conf-no::           r Get next conference number              (116)
* find-previous-conf-no::       r Get previous conference number          (117)
* get-scheduling::              e Get client priority information         (118)
* set-scheduling::              e Alter client priority                   (119)
* set-connection-time-format::  r Use UTC or local timezone of server?    (120)
* local-to-global-reverse::     r Map local text numbers to global ones   (121)
* map-created-texts-reverse::   r Map texts created by a person to global (122)
@end menu

@ifnottex
@node Protocol Notation
@section Protocol Notation
@end ifnottex

The heading for each call looks something like this:

@display
create-person-old [5] (1) Obsolete (10)
@end display

The heading consists of several parts:

@table @asis
@item The name: @samp{create-person-old}
This is the name of the call.  The name is not considered part of the
protocol.  It may change in future versions of this document.  Since
the name is never sent over the network it doesn't matter that much.

@item The call number: @samp{[5]}
The call number is what really matters, since it is sent over the
network.  It will never change.

@item Introduced: @samp{(1)}
The protocol version when the call was first implemented.  Some calls
added more functionality in a later protocol version.  The description
for those calls describes such changes.

@item The status: @samp{Obsolete}
The status of the call (see below).

@item Made obsolete: @samp{(10)}
This figure is only present for some obsolete calls, and it states in
which protocol version the call was obsoleted.

@end table

The status of a call can be any of:

@table @samp
@item Experimental
The call is experimental.  No client should rely on the existence of this
call.  Experimental calls that are useful will usually become recommended
in future versions.

@item Recommended
The call is a standard call.  Clients are recommended to use these calls
rather than experimental or obsolete ones.  Servers are required to
implement all recommended calls.

@item Obsolete
The call should no longer be used by clients.  Servers should implement
these, or they will be incompatible with old client versions.
@emph{Please note:} the documentation for the obsolete calls may be
incomplete.  Many of them perform compatibility magic to ensure that
they never return anything that old clients don't expect.  This
compatibility magic is often documented, but we may have forgotten to
document it in some places.
@end table

@i{A note about the examples:} The examples consist of a number of calls
and replies.
@iftex
Calls are set in a normal typewriter font.  Replies are set in a
slanted typewriter font.
@end iftex
Extra newlines are sometimes inserted in the examples to avoid overly
long lines.

@node login-old
@section login-old [0] (1) Obsolete (4)

@findex login-old
@example
        login-old [0] (( person : @lt{Pers-No};
                         passwd : @lt{HOLLERITH} )) -> ( );
@end example

Log in as a person.  This call has been replaced by @reqlink{login}.

@subheading Error codes

@table @errorcode
@item undefined-person
@rarg{person} is not an existing person.

@item login-disallowed
Logins are not allowed and @rarg{person} does not have the @priv{wheel}
bit set.

@item invalid-password
@rarg{passwd} is not the correct password for @rarg{person}.  The
@field{error-status} indicates the person number.

@end table

@node logout
@section logout [1] (1) Recommended

@findex logout
@example
        logout [1] ( )
                -> ( );
@end example

Log out from LysKOM.

This call does not disconnect the session; use @reqdlink{disconnect}
for that@linkhere{}.

After issuing a @req{logout} call the client can reconnect as the same
or a different person using the @reqdlink{login} call@linkhere{}.

For a client that needs to log in as several different users, issuing
multiple logout and login requests during one session is faster and
places less load on the server than does creating new sessions.

@subheading Error codes

This call never fails.


@node change-conference
@section change-conference [2] (1) Recommended

@findex change-conference
@example
        change-conference [2] ( conference : @lt{Conf-No} )
                -> ( ) ;
@end example

Change current conference of a session.  This call used to be called
pepsi (the name was a very obscure and not very funny joke.)

@subheading Error codes

@table @errorcode
@item login-first
The session is not logged in yet.

@item undefined-conference
Conference @rarg{conference} does not exist or is secret.

@item conference-zero
@rarg{conference} is zero.

@item not-member
The user currently logged in is not a member of @rarg{conference}.
@end table


@node change-name
@section change-name [3] (1) Recommended

@findex change-name
@example
        change-name [3] (( conference : @lt{Conf-No};
                           new-name   : @lt{HOLLERITH} ))
                -> ( ) ;
@end example

This call changes the name of a conference or a person.  To change the
name of a conference the session issuing the call must be logged in as a
person who either has special privileges or is the supervisor of the
conference.


@subheading Error codes

@table @errorcode
@item login-first
The session is not logged in yet.

@item undefined-conference
Conference @rarg{conference} does not exist or is secret.

@item conference-zero
@rarg{conference} is zero.

@item permission-denied
Permission denied.  The @priv{change-name} bit is not set or the user
does not have enough access to @rarg{conference}.

@item conference-exists
@rarg{new-name} is already occupied by another conference.

@item string-too-long
@rarg{new-name} is too long for a valid conference name.

@item bad-name
There are invalid characters in @rarg{new-name}.
@end table


@node change-what-i-am-doing
@section change-what-i-am-doing [4] (1) Recommended

@findex change-what-i-am-doing
@example
        change-what-i-am-doing [4] ( what-am-i-doing : @lt{HOLLERITH} )
                -> ( );
@end example

This call tells the server what the logged-in user is doing.  The string
is usually displayed when a user requests that a client list who is
using LysKOM.  Clients are encouraged to use this call creatively.

@subheading Error codes

@table @errorcode
@item string-too-long
@rarg{what-am-i-doing} is too long.
@end table



@node create-person-old
@section create-person-old [5] (1) Obsolete (10)

@findex create-person-old
@example
        create-person-old [5] (( name   : @lt{HOLLERITH};
                                 passwd : @lt{HOLLERITH} ))
                -> ( @lt{Pers-No} );
@end example

This call requests that the server create a new person with the name and
password given as arguments.  To create a person the session may have to
be logged in as a person with sufficient privileges, if the server is
configured that way.

If the session was not logged in an automatic visible login to the new
person will be performed.

The new person will be a member of exactly one conference: the
associated mailbox.  That membership will have priority 255 and (of
course) position 0.  All flags of the membership will be 0.

@reqexample
@example
        1 5 @holl{24,LysKOM Statistics Daemon} @holl{6,secret}
        @t{=1 6}
@end example

This example creates a new person named ``LysKOM statistics Daemon''
with the password ``secret''. The server has returned the person number
six for the person.


@subheading Error codes

@table @errorcode
@item login-first
The session is not logged in and the server does not allow person
creation before logging in.

@item permission-denied
The server does not allow everyone to create person and the person
currently logged on does not have the @priv{create-pers} bit set.

@item conference-exists
There is already a conference named @rarg{name}.

@item invalid-password
The string @rarg{passwd} is not a valid password.

@item index-out-of-range
Attempt to create a person failed because we reached the maximum number
of conferences permitted.  The @field{error-status} indicates the
person number that should have been created if the limit hadn't been
reached.
@end table



@node get-person-stat-old
@section get-person-stat-old [6] (1) Obsolete (1)

@findex get-person-stat-old
@example
        get-person-stat-old [6] (( person : @lt{Pers-No};
                                   mask   : @lt{INT32} ))
                -> ( @lt{Person} );
@end example

This call returns information about a person.  If the low bit of
@rarg{mask} is not set, the empty string is returned instead of the
@field{username} field.  This call is obsolete and has been replaced
by @reqlink{get-person-stat}.

@subheading Error codes

@table @errorcode
@item login-first
This call can't be executed without logging in first.

@item undefined-person
Person @rarg{person} does not exist.

@item undefined-conference
Conference @rarg{person} does not exist or is secret.

@item conference-zero
@rarg{person} is zero.
@end table

@node set-priv-bits
@section set-priv-bits [7] (1) Recommended

@findex set-priv-bits
@example
        set-priv-bits [7] (( person     : @lt{Pers-No};
                             privileges : @lt{Priv-Bits} )) -> ( );
@end example

This call sets the privileges of @rarg{person} to
@rarg{privileges}.  @xref{Security}.  To successfully issue this call the
session must be logged in as a person with sufficient privileges.

@reqexample
@example
        1 7 6 0010000000000000
        @t{=1}
@end example

This example sets the privileges of person 6 to nothing but
@priv{statistic}.  This particular set of privileges might be useful
for a person used by a statistics-collecting @daemon{}.


@subheading Error codes

@table @errorcode
@item login-first
This call can't be executed without logging in first.

@item undefined-person
@rarg{person} is not a valid person.

@item permission-denied
The person currently logged in does not have the @priv{wheel} bit set
and privilege level set to 6 or higher.
@end table


@node set-passwd
@section set-passwd [8] (1) Recommended

@findex set-passwd
@example
        set-passwd [8] (( person  : @lt{Pers-No};
                          old-pwd : @lt{HOLLERITH};
                          new-pwd : @lt{HOLLERITH} )) -> ( );
@end example

This call is used to set the password of @rarg{person} to
@rarg{new-pwd}.  Any person may set it's own password.  In addition
persons with sufficient privileges may set other persons' passwords.
The password of the person currently logged in must match
@rarg{old-pwd}.

@reqexample
@example
        1 8 5 @holl{6,gazonk} @holl{7,a9go8Hz}
        @t{=1}
@end example

This example sets the password of the LysKOM administrator to ``a9go8Hz''
provided that the old password was ``gazonk''.


@subheading Error codes

@table @errorcode
@item login-first
This call cannot be executed without logging in.

@item undefined-person
@rarg{person} is not a valid person.

@item permission-denied
Attempt to change password of another person without being the
supervisor of that person and without the @priv{wheel} bit set and
privilege level 7 or higher enabled.

@item invalid-password
@rarg{old-pwd} is invalid or @rarg{new-pwd} is invalid as a password.

@end table



@node query-read-texts-old
@section query-read-texts-old [9] (1) Obsolete (10)

@findex query-read-texts-old
@example
        query-read-texts-old [9] (( person     : @lt{Pers-No};
                                    conference : @lt{Conf-No} ))
                -> ( @lt{Membership-Old} );
@end example

This call is used to find the number of unread texts in a conference.
The data it returns is actually a membership structure which specifies
which texts have been read.  It is up to the client to transform the data
to a more usable form.  @rarg{person} is the person being queried
and @rarg{conference} is the conference in question.

Calling @req{query-read-texts-old} does not require the session to be
logged in.

@reqexample
@example
        1 9 6 1
        @t{=1 32 5 11 12 7 93 1 193 1 1 20 133 3 @{ 135 136 137 @}}
@end example

This example finds the read texts for user 6 in conference 1.  The
returned data indicates that the user last read conference 1 (the tenth
number) on Monday July 12th, 1993 at 11:05:32 (the first nine numbers),
that the person has assigned priority 20 to the conference (the eleventh
number) and that all articles up to and including local number 133 plus
articles 135, 136 and 137 have been read.


@subheading Error codes

@table @errorcode
@item undefined-person
@rarg{person} does not exist, or no access to person.
@item undefined-conference
Conference @rarg{conference} does not exist, or is secret.
@item conference-zero
@rarg{conference} is zero.
@item not-member
@rarg{person} is not a member of @rarg{conference}.
@end table



@node create-conf-old
@section create-conf-old [10] (1) Obsolete (10)

@findex create-conf-old
@example
        create-conf-old [10] (( name : @lt{HOLLERITH};
                                type : @lt{Any-Conf-Type} ))
                -> ( @lt{Conf-No} );
@end example

This call is used to create new conferences.  @rarg{name} is the name of
the new conference and @rarg{type} is its type.  If successful, the call
returns the conference number of the newly created conference.

To use this call the session must have logged in as a user with
privileges to create conferences (@pxref{Security}).

@reqexample
@example
        1 50 8
        @t{%1 9 0}
        1 10 @holl{13,@value{IAM}} 00001000
        @t{=1 8}
        1 50 8
        @t{=1 @holl{13,@value{IAM}} 0000
           43 9 17 14 5 96 5 165 1
           43 9 17 14 5 96 5 165 1
           5 0 5 0 5 0 77 0 1 0}
@end example

This example creates a new conference named
``@value{IAM}''@footnote{This conference is a standard Lysator
conference.  It's all Padrone's fault.} which accepts all users as
members and accepts anonymous articles.  The server returns 7 as the
new conference number.


@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.

@item permission-denied
The server does not allow everyone to create a conference and user does
not have the @req{create-conf} bit set.

@item conference-exists
A conference named @rarg{name} already exists.

@item bad-name
@rarg{name} contains invalid characters.

@item string-to-long
@rarg{name} is too long to be used as a conference name.

@item secret-public
The conference type @rarg{type} has the @conftype{secret} bit set, but
the @conftype{rd-prot} bit is cleared.

@item index-out-of-range
Attempt to create a conference failed because we reached the maximum
number of conferences permitted.  The @field{error-status} indicates
the conference number that should have been created if the limit
hadn't been reached.
@end table



@node delete-conf
@section delete-conf [11] (1) Recommended

@findex delete-conf
@example
        delete-conf [11] ( conf : @lt{Conf-No} ) -> ( );
@end example

This call deletes the conference @rarg{conf} from the LysKOM
database.  Only privileged users and the supervisors of a conference may
delete it.  If the conference is a mailbox the corresponding person will
also be deleted.

@reqexample
@example
        1 50 7
        @t{=1 @holl{4,Test} 1001
           16 4 19 10 5 96 1 161 1
           16 4 19 10 5 96 1 161 1
           7 0 7 0 0 0 77 1 1 0}
        1 11 7
        @t{=1}
        1 50 7
        @t{%1 9 0}
@end example

This example shows the successful deletion of conference number seven.

@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.

@item undefined-conference
@rarg{conf} does not exist or is secret.

@item conference-zero
@rarg{conf} is zero.

@item permission-denied
Not supervisor of @rarg{conf} and not enough privileges enabled.

@item undefined-person
@rarg{conf} is a mailbox but does not exist as a person (the database
is corrupt.)
@end table


@node lookup-name
@section lookup-name [12] (1) Obsolete (7)

@findex lookup-name
@example
        lookup-name [12] ( name : @lt{HOLLERITH} )
                -> ( @lt{Conf-List-Archaic} );
@end example

This call returns a list of conferences matching the string @rarg{name}.
lookup-name has been superseded by @reqlink{lookup-z-name}.

@c ispell-ignore
@reqexample
@example
        1 12 @holl{3,a d}
        @t{=1 3 @{ 217 674 1582 @} @{ 0000 1001 0000 @}}
        2 12 @holl{3,:::}
        @t{=2 0 * *}
        3 76 @holl{3,a d} 1 1
        @t{=3 3 @{ @holl{31,Alkohol- (och annan) drogdebatt} 0000 217
               @holl{13,Anna Degerman} 1001 674
               @holl{27,Anarchy discussion (import)} 0000 1582 @}}
        4 76 @holl{3,:::} 1 1
        @t{=4 0 *}
@end example
@c ispell-end-ignore

This example shows two attempts to look up a name.  The first example
looks up @samp{a d} and finds three matches (the middle, number 674,
is a person).  The second example looks up @samp{:::} which doesn't
match any conference (or person).  Call number 3 and 4 issues the same
lookup using the @reqdlink{lookup-z-name} call@linkhere{}.
(The return value for call number 3 has been broken into three lines
to fit on the page.)

@subheading Error codes

This call always succeeds.


@node get-conf-stat-older
@section get-conf-stat-older [13] (1) Obsolete (1)

@findex get-conf-stat-older
@example
        get-conf-stat-older [13] (( conf-no : @lt{Conf-No};
                                    mask    : @lt{INT32} ))
                -> ( @lt{Conference-Old} );
@end example

This call retrieves the information associated with conference
@rarg{conf-no} in the LysKOM server.  This call should no longer be
used; use @reqdlink{get-conf-stat} instead@linkhere{}.

The @rarg{mask} argument determines if the name is returned or not.  If
the lowest bit is 1 the name is returned, otherwise the empty string is
returned instead of the name.


@subheading Error codes

@table @errorcode
@item undefined-conference
@rarg{conf-no} does not exist or is secret.
@item conference-zero
@rarg{conf-no} is zero.

@end table




@node add-member-old
@section add-member-old [14] (1) Obsolete (10)

@findex add-member-old
@example
        add-member-old [14] (( conf-no  : @lt{Conf-No};
                               pers-no  : @lt{Pers-No};
                               priority : @lt{INT8};
                               where    : @lt{INT16} ))
                -> ( );
@end example

Make the person @rarg{pers-no} a member of conference @rarg{conf-no}.
The membership priority is set to @rarg{priority} and its position in
the membership list is set to @rarg{where}.

This call can be used to change the priority and position of a
conference in the person's membership list if the person is already a
member of the conference.

In protocol version 10, setting the priority to zero sets the passive
bit in the membership.  The actual priority is not changed.

@reqexample
@example
        1 46 119 0 10 0
        @t{=1 1 @{ 49 14 17 13 8 91 5 255 1 119 255 0 0 * @}}
        1 14 1 119 250 0
        @t{=1}
        1 46 119 0 10 0
        @t{=1 2 @{ 52 30 14 11 5 96 2 162 1 1 250 0 0 *
               49 14 17 13 8 91 5 255 1 119 255 0 0 * @}}
@end example

This example makes person 119 (me) a member of conference number 1.  The
priority is set to 250 and the conference is placed first in the
membership list.  The first and last calls of the example show the
membership list for person 119 before and after the call.


@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.

@item undefined-conference
Conference @rarg{conf-no} does not exist or is secret.

@item conference-zero
@rarg{conf-no} is zero.

@item undefined-person
Person @rarg{pers-no} does not exist

@item access-denied
Not enough permissions or privileges to add members to conference
@rarg{conf-no}.

@item permission-denied
Person @rarg{pers-no} is already a member of conference @rarg{conf-no},
but the person logged on is not a supervisor and does not have enough
privileges to change the priorities of person @rarg{pers-no}.

@end table



@node sub-member
@section sub-member [15] (1) Recommended

@findex sub-member
@example
        sub-member [15] (( conf-no : @lt{Conf-No};
                           pers-no : @lt{Pers-No} ))
                -> ( );
@end example

Removes the person @rarg{pers-no} from the membership list of conference
@rarg{conf-no} and remove the conference from the person's list of
memberships.

@reqexample
@example
        1 46 5 0 100 0
        @t{=1 2 @{ 44 14 19 10 5 96 1 161 1 1   0 0 0 *
               49 14 17 13 8 91 5 255 1 5 255 0 0 * @}}
        1 15 1 5
        @t{=1}
        1 46 5 0 100 0
        @t{=1 1 @{ 49 14 17 13 8 91 5 255 1 5 255 0 0 * @}}
@end example

This example shows how person 5 is removed from conference one.  The
calls to @req{get-membership-old} demonstrate the effects on the
LysKOM database.


@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.

@item undefined-conference
Conference @rarg{conf-no} does not exist or is secret.

@item conference-zero
@rarg{conf-no} is zero.

@item undefined-person
Person @rarg{pers-no} does not exist.

@item not-member
Person @rarg{pers-no} is not a member of conference @rarg{conf-no}.

@item permission-denied
Not supervisor of conference @rarg{conf-no} or not supervisor of person
@rarg{pers-no} and not enough privileges to issue the call anyway.
@field{error-status} contains the conference number.

@end table




@node set-presentation
@section set-presentation [16] (1) Recommended

@findex set-presentation
@example
        set-presentation [16] (( conf-no : @lt{Conf-No};
                                 text-no : @lt{Text-No} ))
                -> ( );
@end example

This call sets the presentation text of the conference or person
@rarg{conf-no} to the text @rarg{text-no}.  To remove a presentation, use
a @rarg{text-no} of zero.  This call protects the new presentation from
being deleted automatically and removes such protection from the old
presentation.  In lyskomd this is implemented by increasing the mark
count on presentation texts.

@reqexample
@example
        1 50 6
        @t{=1 @holl{11,David Byers} 1001
           26 15 11 9 5 96 0 160 1
           26 15 11 9 5 96 0 160 1
           5 0 5 0 5 0 77 1 1 0}
        1 16 6 1
        @t{=1}
        1 50 6
        @t{=1 @holl{11,David Byers} 1001
           26 15 11 9 5 96 0 160 1
           26 15 11 9 5 96 0 160 1
           5 1 5 0 5 0 77 1 1 0}
@end example

This example shows how the presentation of person 6 is being
changed.  To start with, the person had no presentation, as is shown by
the @reqdlink{get-conf-stat-old} call@linkhere{}.  Later, after
@req{set-presentation} has been called, the presentation field has
changed.


@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.

@item undefined-conference
Conference @rarg{conf-no} does not exist or is secret.

@item conference-zero
@rarg{conf-no} is zero.

@item permission-denied
Not enough permissions to change presentation of conference
@rarg{conf-no}.

@item no-such-text
Text @rarg{text-no} does not exist or no read permission.

@item mark-limit
Adding a mark to text @rarg{text-no} would cause it to have too many
marks.

@end table



@node set-etc-motd
@section set-etc-motd [17] (1) Recommended

@findex set-etc-motd
@example
        set-etc-motd [17] (( conf-no : @lt{Conf-No};
                             text-no : @lt{Text-No} ))
                -> ( );
@end example

This call sets the message of the day on the conference or person
@rarg{conf-no} to the article @rarg{text-no} and removes the old
message.  To remove an old message without setting a new one, use a
@rarg{text-no} of zero.  This call protects the new message from
automatic deletion and removes such protection from the old message just
as @reqlink{set-presentation}.

@reqexample
@example
        1 50 6
        @t{=1 @holl{11,David Byers} 1001
           26 15 11 9 5 96 0 160 1
           26 15 11 9 5 96 0 160 1
           5 0 5 0 5 0 77 1 1 0}
        1 17 6 1
        @t{=1}
        1 50 6
        @t{=1 @holl{11,David Byers} 1001
           26 15 11 9 5 96 0 160 1
           26 15 11 9 5 96 0 160 1
           5 0 5 0 5 1 77 1 1 0}
@end example

This example shows how text number one is used as the message of the day
for conference six (which happens to be a mailbox.) The
@req{get-conf-stat-old} calls before and after demonstrate the change in
the conference structure.


@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.

@item undefined-conference
Conference @rarg{conf-no} does not exist or is secret.

@item conference-zero
@rarg{conf-no} is zero.

@item permission-denied
Not enough permissions to set the MOTD of conference @rarg{conf-no}.

@item mark-limit
Adding a mark to text @rarg{text-no} would cause it to have too many
marks.
@end table




@node set-supervisor
@section set-supervisor [18] (1) Recommended

@findex set-supervisor
@example
        set-supervisor [18] (( conf-no : @lt{Conf-No};
                               admin   : @lt{Conf-No} ))
                -> ( );
@end example

The @req{set-supervisor} call changes the supervisor of an existing
conference.  The result is that all members of the conference
@rarg{admin} become supervisors of the conference @rarg{conf-no}.
Typically, but not always, @rarg{admin} will be a mailbox.

@reqexample
@example
        1 50 4
        @t{=1 @holl{17,Nyheter om LysKOM} 0000
           48 11 17 13 8 91 5 255 1
           15 12 11  9 5 96 0 160 1
           0 0 0 0 0 0 77 1 1 1}
        1 18 4 6
        @t{=1}
        1 50 4
        @t{=1 @holl{17,Nyheter om LysKOM} 0000
           48 11 17 13 8 91 5 255 1
           15 12 11  9 5 96 0 160 1
           0 0 6 0 0 0 77 1 1 1}
@end example

This example makes the members of conference six supervisors of
conference four (which is usually the ``News about LysKOM''
conference).  The change in the conference structure is evident from
the @reqdlink{get-conf-stat-old} calls@linkhere{} before and after the
@req{set-supervisor} call.  Note that the original supervisor was not
set.  In order to change the supervisor of such a conference, the
session issuing the call must have administration privileges.


@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.

@item undefined-conference
Conference @rarg{conf-no} or conference @rarg{admin} does not exist or
is secret.

@item conference-zero
@rarg{conf-no} is zero.

@item permission-denied
Not enough permissions or privileges to change the supervisor of
conference @rarg{conf-no}.

@end table





@node set-permitted-submitters
@section set-permitted-submitters [19] (1) Recommended

@findex set-permitted-submitters
@example
        set-permitted-submitters [19] (( conf-no  : @lt{Conf-No};
                                         perm-sub : @lt{Conf-No} ))
                -> ( );
@end example

This call grants the right to send articles to the conference
@rarg{conf-no} to all members of the conference @rarg{perm-sub}.  If
@rarg{perm-sub} is 0, everybody can send articles to the conference.
(This is the default setting of new conferences and persons.)

When a person tries to submit an article but does not have the right
to do so, the server will send the article to the super-conference
instead.

@reqexample
@example
        1 50 4
        @t{=1 @holl{17,Nyheter om LysKOM} 0000
           48 11 17 13 8 91 5 255 1
           15 12 11  9 5 96 0 160 1
           0 0 6 0 0 0 77 1 1 1}
        1 19 4 1
        @t{=1}
        1 50 4
        @t{=1 @holl{17,Nyheter om LysKOM} 0000
           48 11 17 13 8 91 5 255 1
           15 12 11  9 5 96 0 160 1
           0 0 6 1 0 0 77 1 1 1}
@end example

This example shows how all members of conference one are given
permission to send articles to conference four.  From the beginning,
only members of conference four were permitted to submit articles.  The
change is evident from the @reqdlink{get-conf-stat-old}
calls@linkhere{} before and after the @req{set-permitted-submitters}
call.


@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.

@item undefined-conference
Conference @rarg{conf-no} or conference @rarg{perm-sub} does not exist
or is secret.

@item conference-zero
@rarg{conf-no} is zero.

@item permission-denied
Not enough permissions to change the permitted submitters of conference
@rarg{conf-no}.

@end table



@node set-super-conf
@section set-super-conf [20] (1) Recommended

@findex set-super-conf
@example
        set-super-conf [20] (( conf-no    : @lt{Conf-No};
                               super-conf : @lt{Conf-No} ))
                -> ( );
@end example

Makes the conference @rarg{super-conf} the super-conference of the
conference @rarg{conf-no}.  @xref{Conference Status Types}, for more
info on what this field is used for.

@reqexample
@example
        1 50 4
        @t{=1 @holl{17,Nyheter om LysKOM} 0000
           48 11 17 13 8 91 5 255 1
           15 12 11  9 5 96 0 160 1
           0 0 6 0 0 0 77 1 1 1}
        2 20 4 8
        @t{=2}
        3 50 4
        @t{=3 @holl{17,Nyheter om LysKOM} 0000
           48 11 17 13 8 91 5 255 1
           15 12 11  9 5 96 0 160 1
           0 0 6 0 8 0 77 1 1 1}
@end example

This example demonstrates how the super-conference of conference 1 is
set to conference 8.  The calls to @reqlink{get-conf-stat-old} demonstrate the
change in the conference structure.


@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.
@item undefined-conference
Conference @rarg{conf-no} or conference @rarg{super-conf} does not exist
or is secret.
@item conference-zero
@rarg{conf-no} is zero.
@item permission-denied
Not enough permissions to change super-conference of conference
@rarg{conf-no}.
@end table



@node set-conf-type
@section set-conf-type [21] (1) Recommended

@findex set-conf-type
@example
        set-conf-type [21] (( conf-no : @lt{Conf-No};
                                 type : @lt{Any-Conf-Type} ))
                -> ( );
@end example

Sets the conference type of conference @rarg{conf-no} to @rarg{type}.
Before protocol version 8, @rarg{type} could only be four bits.  Starting
with protocol version 8, either a four-bit @type{Conf-Type} or an
eight-bit @type{Extended-Conf-Type} is allowed.

@reqexample
@example
        1 78 4
        @t{=1 @holl{17,Nyheter om LysKOM} 00001000 1 77}
        1 21 4 00000000
        @t{=1}
        1 78 4
        @t{=1 @holl{17,Nyheter om LysKOM} 00000000 1 77}
@end example

This example shows a user removing the @conftype{allow-anonymous} bit
from conference four.  The @reqdlink{get-uconf-stat} call@linkhere{}
shows all eight bits of the conference type before and after the
@req{set-conf-type} call.

@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.
@item undefined-conference
Conference @rarg{conf-no} does not exist or is secret.
@item conference-zero
@rarg{conf-no} is zero.
@item secret-public
@rarg{type} has @conftype{secret} bit but not @conftype{rd-prot}.
@item permission-denied
Not enough permissions or privileges to change the conference type of
conference @rarg{conf-no}.
@item letterbox
Attempt to change the @conftype{letterbox} flag.
@item invalid-membership-type
Attempt to change to a conference type that is not compatible with one of
more members of the conference (for example, attempting to set
@conftype{forbid-secret} on a conference with a secret member.)
@field{error-status} is the id of the first person with an incompatible
membership type.
@end table


@node set-garb-nice
@section set-garb-nice [22] (1) Recommended

@findex set-garb-nice
@example
        set-garb-nice [22] (( conf-no : @lt{Conf-No};
                                 nice : @lt{Garb-Nice} ))
                -> ( );
@end example

Sets the expiration time for articles in conference @rarg{conf-no} to
@rarg{nice} days.  An article that is older than the maximum expiration
time of each conference it is sent to may be deleted by the LysKOM
server unless it has marks.

@reqexample
@example
        1 78 4
        @t{=1 @holl{17,Nyheter om LysKOM} 00000000 1 77}
        1 22 4 7
        @t{=1}
        1 78 4
        @t{=1 @holl{17,Nyheter om LysKOM} 00000000 1 7}
@end example

This example shows the expiration time of conference four being lowered
from 77 to just seven days.

@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.
@item undefined-conference
Conference @rarg{conf-no} does not exist or is secret.
@item conference-zero
@rarg{conf-no} is zero.
@item permission-denied
Not enough permissions to change the expiration time for conference
@rarg{conf-no}.
@end table




@node get-marks
@section get-marks [23] (1) Recommended

@findex get-marks
@example
        get-marks [23] ( )
                -> ( @lt{ARRAY} @lt{Mark} );
@end example

This call returns the list of marks the current user has set.

@reqexample
@example
        1 23
        @t{=1 3 @{ 13020 100 13043 95 12213 95 @}}
@end example

In this example, the current user has three marks, one on text 13020
with mark type 100, one on text 13042 with mark type 95 and one on text
12213 with mark type 95.  The maximum number of marks may be arbitrarily
limited in the LysKOM server.

@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.
@end table



@node mark-text-old
@section mark-text-old [24] (1) Obsolete (4)

@findex mark-text-old
@example
        mark-text-old [24] (( text      : @lt{Text-No};
                              mark-type : @lt{INT8} ))
                -> ( );
@end example

This call has been replaced by @reqlink{mark-text} and
@reqlink{unmark-text} and should no longer be used.
This call can only set @rarg{mark-type} to a value in the range 1 to
255 (inclusive).  If @rarg{mark-type} is set to 0 the mark will be
removed.

@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.

@item no-such-text
The text @rarg{text} does not exist.

@item permission-denied
No read permission on text @rarg{text}.

@item undefined-person
The person currently logged in does not exist (can't happen error.)

@item too-many-marks
Marking the text would cause the person doing the marking to have too
many marks, or cause the text to have too many marks.
@end table




@node get-text
@section get-text [25] (1) Recommended

@findex get-text
@example
        get-text [25] (( text       : @lt{Text-No};
                         start-char : @lt{INT32};
                         end-char   : @lt{INT32} ))
                -> ( @lt{HOLLERITH} );
@end example

Retrieve text number @rarg{text} from the LysKOM database, starting at
position @rarg{start-char} and ending at position @rarg{end-char}.  The
first character in the text is numbered 0 and the last can be retrieved
using @reqlink{get-text-stat}.  It is also permitted to request a character
position beyond the actual end of the text, in which case as much text
as is available will be returned.

@reqexample
@example
        1 25 100 0 32766
        @t{=1 @holl{25,Yawn@bullet{}Nothing is happening}}
        2 25 100 5 32766
        @t{=2 @holl{20,Nothing is happening}}
        3 25 100 0 3
        @t{=3 @holl{4,Yawn}}
@end example

In the example, @code{@bullet{}} represents a linefeed.

In this example, text 100 is requested three times, first from position
0 to position 32766, then from position 5 to position 32766 and finally
from position 0 to position 4.  The first reply contains the entire text,
the following two contain only the requested portion.


@subheading Error codes

@table @errorcode
@item no-such-text
The text @rarg{text} does not exits or no read permission.
This error code will also be used when attempting to fetch texts
without logging in first.  (There are some texts that are readable
without logging in: the motd-of-lyskom (@pxref{set-motd-of-lyskom}),
and texts with the @aux{world-readable} aux item set on them.)

@item text-zero
Attempt to retrieve text number 0.

@item index-out-of-range
@rarg{start-char} is larger than the length of the text.
@end table




@node get-text-stat-old
@section get-text-stat-old [26] (1) Obsolete (10)

@findex get-text-stat-old
@example
        get-text-stat-old [26] ( text-no : @lt{Text-No} )
                -> ( @lt{Text-Stat-Old} );
@end example

Get information about text number @rarg{text-no}.  The text-stat contains
information about the size of the text, its recipients, comments, author
and more.

For compatibility reasons this call will only return the misc-infos
0=recpt, 1=cc-recpt, 2=comm-to, 3=comm-in, 4=footn-to, 5=footn-in,
6=loc-no, 7=rec-time, 8=sent-by and 9=sent-at.  Newer misc-infos will
either be removed or converted to a similar one.  Specifically,
15=bcc-recpt may (at the servers discretion) be converted to 1=cc-recpt
or omitted entirely.


@reqexample
@example
        1 26 100
        @t{=1 7 35 16 15 6 96 1 196 1 14 1 22 1
           7 @{ 0 7 6 85 0 15 6 1
           8 13 9 12 37 16 15 6 96 1 196 1
           3 311 @}}
@end example

In this example, text number 100 was created by person 7 at
approximately 4:35PM on July 15 1996.  Its recipients are conferences 7
and 15, and it was sent to conference 15 by person 13 at 16:37 on the
day it was created.  The text has a single comment: text 311.


@subheading Error codes

@table @errorcode
@item no-such-text
The text @rarg{text-no} does not exist, or no read access.
This error code will also be used when attempting to fetch texts
without logging in first.  (There are some texts that are readable
without logging in: the motd-of-lyskom (@pxref{set-motd-of-lyskom}),
and texts with the @aux{world-readable} aux item set on them.)

@item text-zero
Attempt to retrieve text number 0.
@end table



@node mark-as-read
@section mark-as-read [27] (1) Recommended

@findex mark-as-read
@example
        mark-as-read [27] (( conference : @lt{Conf-No};
                             text       : @lt{ARRAY} @lt{Local-Text-No} ))
                -> ( );
@end example

Marks text @rarg{text} in conference number @rarg{conference} as read
for the current user.  This call updates the membership record for the
user.

@reqexample
@example
        1 9 6 7
        @t{=1 20 32 11 17 6 96 3 198 1 7 1 240 0 *}
        1 78 7
        @t{=1 @holl{13,@value{IAM}} 00001000 241 1}
        1 27 7 1 @{ 241 @}
        @t{=1}
        1 9 6 7
        @t{=1 20 32 11 17 6 96 3 198 1 7 1 241 0 *}
@end example

This example shows person 6 marking local text number 241 in conference
7 as read.  In the first @req{query-read-texts-old} call the person
has read local text 240, but nothing higher.  The @req{mark-as-read}
call is reflected in the second @req{query-read-texts-old} call, where
the user is seen to have read text 241 in conference 7.

To mark a global text number as read it is necessary to translate it
into local text numbers by looking at the misc-info list in the
@type{Text-Stat} and calling @req{mark-as-read} once for each recipient.

There is no need to call @req{mark-as-read} on deleted texts.  The
server will automatically mark them as read, sooner or later.

@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.
@item undefined-conference
The conference @rarg{conference} does not exist or is secret.
@item conference-zero
@rarg{conference} is zero.
@item not-member
The person logged on is not a member of conference @rarg{conference}.
@item no-such-local-text
One of the numbers in @rarg{text} is not a local text number in
@rarg{conference}.  The error argument indicates the index of the invalid
number.
@item local-text-zero
One of the numbers in @rarg{text} is zero.
@end table



@node create-text-old
@section create-text-old [28] (1) Obsolete (10)

@findex create-text-old
@example
        create-text-old [28] (( text        : @lt{HOLLERITH};
                                misc-info   : @lt{ARRAY} @lt{Misc-Info} ))
                -> ( @lt{Text-No} );
@end example

Creates a new text with contents from @rarg{text} and recipients
etc. defined by @rarg{misc-info} (@pxref{The Misc-Info List}).  In
addition to the result, the server will send an asynchronous message
to all members of any of the recipients of the new text.  It is not
defined whether this messages comes before or after the reply to
the create-text message.  Clients should be prepared for either
situation.

The text up to the first linefeed is considered to be the subject
line.  The remaining text is the message body.  Although messages with
only a subject are valid, clients should avoid letting users create
such messages.

The only Misc-Info items valid for this call are @misc{recpt},
@misc{cc-recpt}, @misc{bcc-recpt} (protocol version 10),
@misc{comm-to} and @misc{footn-to}.

@reqexample
@example
        1 28 @holl{20,Example@bullet{}Message body} 3 @{ 0 5 1 112 2 33467 @}
        @t{:16 0 33502 13 16 15 16 6 97 3 196 1 119 1 20 0}
        @t{    5 @{ 0 5 6 148 1 112 6 3438 2 33467 @} }
        @t{=1 33502}
@end example

In the example, @code{@bullet{}} represents a linefeed.

In this example, person 119 creates a text containing a subject and a
one-line body.  The recipient of the text is conference five, conference
112 is a CC recipient and the text is a comment to text 33467.  The
server reply indicates that the new text has been given number 33502.
Finally there is an asynchronous message sent to all members of
recipient conferences.  Note how the message was sent before the reply to
the client.  The misc-info list in this message has two additional
fields, the local numbers of the text in each of its recipient
conferences.


@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.

@item string-too-long
The string @rarg{text} is longer than the maximum length of a message.

@item temporary-failure
The text could not be created at the moment.

@item no-such-text
Attempt to comment or footnote a non-existent or secret text.

@item not-author
Attempt to footnote a text authored by someone else.

@item footnote-limit
Attempt to footnote a text with the maximum number of footnotes already
set.

@item comment-limit
Attempt to comment a text with the maximum number of comments already
set.

@item index-out-of-range
Attempt to create a text failed because we reached the maximum number
of texts permitted.  The @field{error-status} indicates the text
number that should have been created if the limit hadn't been reached.

@item access-denied
Attempt to send a text to a conference failed because no access to the
conference or any super conference that will accept a text.

@item anonymous-rejected
Attempt to send an anonymous text to a conference that does not accept
anonymous texts.

@item illegal-misc
Invalid misc-info list.  A recipient is listed more than once or there is
an unknown misc item in the misc-info list.
@end table



@node delete-text
@section delete-text [29] (1) Recommended

@findex delete-text
@example
        delete-text [29] ( text : @lt{Text-No} )
                -> ( );
@end example

Deletes the text @rarg{text} from the LysKOM database, if the person
issuing the command may do so.

@reqexample
@example
        1 29 33467
        @t{=1}
@end example

This simple example shows the deletion of text number 33467.


@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.
@item no-such-text
The text @rarg{text} does not exist or no read access.
@item not-author
The person logged in is not the text author or supervisor of the text
author.
@end table



@node add-recipient
@section add-recipient [30] (1) Recommended

@findex add-recipient
@example
        add-recipient [30] (( text-no       : @lt{Text-No};
                              conf-no       : @lt{Conf-No};
                              recpt-type    : @lt{Info-Type} ))
                -> ( );
@end example

Adds @rarg{conf-no} as recipient to text @rarg{text-no}.  If
@rarg{recpt-type} is 1, then a @misc{cc-recpt} (@pxref{The Misc-Info
List}) is created; otherwise a @misc{recpt} is created.

Since protocol version 8 this call can also be used to change a
@misc{cc-recpt} into a @misc{recpt} and vice versa by simply adding
a recipient that already exists.

Since protocol version 10 the @rarg{recpt-type} parameter is a
@type{Misc-Info}.  Only infos @misc{recpt}, @misc{cc-recpt} and
@misc{bcc-recpt} are accepted.  In protocol version 9 and earlier this
argument was a @type{BOOL}, that indicated if the recipient should be
a @misc{cc-recpt} (when true) or @misc{recpt} (when false).

@reqexample
@example
        1 26 1
        @t{=1 2 22 12 17 6 97 4 197 1 5 4 256 1 0 *}
        1 30 1 5 0
        @t{=1}
        1 26 1
        @t{=1 2 22 12 17 6 97 4 197 1 5 4 256 1}
        @t{   3 @{ 0 5 6 1 9 34 34 17 17 6 97 4 197 1 @}}
        1 30 1 5 1
        @t{=1}
        1 26 1
        @t{=1 2 22 12 17 6 97 4 197 1 5 4 256 1}
        @t{   3 @{ 1 5 6 1 9 34 34 17 17 6 97 4 197 1 @}}
@end example

This example show how conference 5 is added first as a recipient of text
1, then changed to a carbon-copy recipient.  The misc-info list reflects
these changes.


@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.

@item undefined-conference
The conference @rarg{conf-no} does not exist.

@item conference-zero
@rarg{conf-no} is zero.

@item no-such-text
The text @rarg{text-no} does not exist.

@item already-recipient
The conference @rarg{conf-no} is already a recipient of the same type as
@rarg{recpt-type}.

@item illegal-info-type
@rarg{recpt-type} is not @misc{recpt}, @misc{cc-recpt} or
@misc{bcc-recpt}.

@item recipient-limit
The text already has the maximum number of recipients.

@item permission-denied
Attempt to change recipient types of a recipient without being the
supervisor of either the author, recipient, or sender of the
recipient.

@item access-denied
Attempt to add a conference as recipient that the person logged on does
not have permission to add texts to.  The client may have to chase the
super conf chain.

@end table




@node sub-recipient
@section sub-recipient [31] (1) Recommended

@findex sub-recipient
@example
        sub-recipient [31] (( text-no   :   @lt{Text-No};
                              conf-no   :   @lt{Conf-No} ))
                -> ( );
@end example

Removes @rarg{conf-no} from the list of recipients of text
@rarg{text-no}.  Recipients may be removed by the author of the text or
by the supervisor of the recipients of the text or by the supervisor of
the author.

@reqexample
@example
        1 26 1
        @t{=1 2 22 12 17 6 97 4 197 1 5 4 256 1}
        @t{   3 @{ 1 5 6 1 9 34 34 17 17 6 97 4 197 1 @}}
        1 31 1 5
        @t{=1}
        1 26 1
        @t{=1 2 22 12 17 6 97 4 197 1 5 4 256 1 0 *}
        1 31 1 5
        @t{%1 30 0}
@end example

In this example, conference 5 is removed from the recipient list of text
number 5.  When the call is repeated, the server simply returns an error
since conference 5 is not a recipient of the text.

@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.

@item no-such-text
The text @rarg{text-no} does not exist or is secret.

@item not-recipient
The conference @rarg{conf-no} is not a recipient of text @rarg{text-no}.

@item undefined-conference
The conference @rarg{conf-no} does not exist or is secret.

@item conference-zero
@rarg{conf-no} is zero.

@item permission-denied
Not supervisor of text author or conference, and not sender of text to
@rarg{conf-no} and not enough privileges set and enabled.

@end table


@node add-comment
@section add-comment [32] (1) Recommended

@findex add-comment
@example
        add-comment [32] (( text-no     :       @lt{Text-No};
                            comment-to  :       @lt{Text-No} ))
                -> ( );
@end example

Add a comment link between the text @rarg{comment-to} and the text
@rarg{text-no} (@rarg{text-no} becomes a comment to the text
@rarg{comment-to}).  This call is used to add comment links after a text
has been created.  The normal procedure for creating comments is to add a
@misc{comm-to} element to the text's misc-info list when the text is
created (@pxref{The Misc-Info List}).

@reqexample
@example
        1 26 1
        @t{=1 2 22 12 17 6 97 4 197 1 5 4 256 1 0 *}
        1 26 2
        @t{=1 49 49 18 17 6 97 4 197 1 5 1 52 1 2 @{ 0 2 6 1 @}}
        1 32 2 1
        @t{=1}
        1 26 1
        @t{=1 2 22 12 17 6 97 4 197 1 5 4 256 1 1 @{ 3 2 @}}
        1 26 2
        @t{=1 49 49 18 17 6 97 4 197 1 5 1 52 1}
        @t{   4 @{ 0 2 6 1 2 1 9 19 52 18 17 6 97 4 197 1 @}}
@end example

In this example, text number two is added as a comment to text number
one.  The change is reflected in the Misc-Info List of the texts.


@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.

@item index-out-of-range
The texts @rarg{text-no} and @rarg{comment-to} are identical.  The
@field{error-status} is @rarg{text-no}.

@item no-such-text
The text @rarg{text-no} of @rarg{comment-to} are undefined.

@item comment-limit
The text @rarg{comment-to} already has the maximum number of comments.

@item already-comment
The text @rarg{text-no} is already a comment of @rarg{comment-to}.

@item already-footnote
The text @rarg{text-no} is already a footnote of @rarg{comment-to},
and a text cannot be both a comment and a footnote to the same text.

@end table




@node sub-comment
@section sub-comment [33] (1) Recommended

@findex sub-comment
@example
        sub-comment [33] (( text-no      :       @lt{Text-No};
                            comment-to   :       @lt{Text-No} ))
                -> ( );
@end example

This call removes the text @rarg{text-no} from @rarg{comment-to}'s list
of comments.

@reqexample
@example
        1 26 1
        @t{=1 2 22 12 17 6 97 4 197 1 5 4 256 1 1 @{ 3 2 @}}
        1 26 2
        @t{=1 49 49 18 17 6 97 4 197 1 5 1 52 1}
        @t{   4 @{ 0 2 6 1 2 1 9 19 52 18 17 6 97 4 197 1 @}}
        1 33 2 1
        @t{=1}
        1 26 1
        @t{=1 2 22 12 17 6 97 4 197 1 5 4 256 1 0 *}
        1 26 2
        @t{=1 49 49 18 17 6 97 4 197 1 5 1 52 1 2 @{ 0 2 6 1 @}}
@end example

In this example text 2 is a comment to text 1, as shown by the misc-info
lists of the two texts.  The @req{sub-comment} is called.  The misc-info
lists are changed to reflect the change.


@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.
@item no-such-text
One of the texts @rarg{text-no} or @rarg{comment-to} does not exist.
@item not-comment
The text @rarg{text-no} is not a comment to @rarg{comment-to}.
@item permission-denied
Not supervisor of author of @rarg{text-no} or not sender of the
comment and not enough privileges set and enable to complete the call
anyway.
@end table





@node get-map
@section get-map [34] (1) Obsolete (10)

@findex get-map
@example
        get-map [34] (( conf-no         :       @lt{Conf-No};
                        first-local-no  :       @lt{Local-Text-No};
                        no-of-texts     :       @lt{INT32} ))
                -> ( @lt{Text-List} );
@end example

This call has been superseded by @reqlink{local-to-global}.

This call retrieves an array mapping local text numbers to global
numbers.  It is most often used to get a list of unread texts in a
conference.  Clients will usually use the @reqlink{query-read-texts} or
@reqlink{get-membership} calls to find the last local number a user has
read in a particular conference, then use the @req{get-map} call to
retrieve the global numbers of all unread texts in the conference.

The @rarg{conf-no} parameter specifies which conference to get the map
of.  @rarg{first-local-no} is the local number of the first text returned
by the call.  @rarg{no-of-texts} is the maximum number of text the client
wants.

The result is a list of global text numbers.  The first element of the
list is the global number of local number @rarg{first-local-no},
specified by the call; the second element is the global number of local
number @rarg{first-local-no} plus one; and so forth.  The list returned
by the server is at most @rarg{no-of-texts} long, but may be shorter if
the call specifies more texts that there are in the conference.

If @rarg{first-local-no} is higher than the highest local text number,
the server will return an error.

If @rarg{first-local-no} is lower than the lowest number that still
exists, the server will set @rarg{first-local-no} in the returned
@type{Text-List} to the first text that still exists.  The size of the
returned array will be decreased by the same amount as
@rarg{first-local-no} is increased.  This may result in an empty array
being returned.  (This paragraph applies even when @rarg{first-local-no}
is 0.)

If no texts at all exists in @rarg{conf-no} the resulting array will be
empty, and @rarg{first-local-no} will be set to the number the next text
to be created will receive.

@reqexample
@example
        1 34 119 10 5
        @t{=1 10 5 @{ 0 0 466 478 391 @}}
        2 34 119 16 5
        @t{=2 16 3 @{ 481 0 491 @}}
        3 34 119 19 5
        @t{%3 16 0}
        4 34 120 1 5
        @t{=4 4 2 @{ 480 485 @}}
        5 34 120 1 2
        @t{=5 4 0 *}
@end example

This example shows five @req{get-map} calls.  The first retrieves the
mappings of local numbers 10 to 15; the second call returns local
numbers 16 to 18.  As this example shows the maps are not necessarily
sorted in ascending order, since texts may be added after their
creation, and the maps may contain zeroes anywhere.  These represent
texts that have been removed for some reason.

Since the first example returned two leading zeroes we can be certain
that at least one text with a local text number lower than 10 still
exists.  Otherwise the result would have been truncated in the front as
it is in examples 4 and 5.

The third exchange in the example shows what happens when
@rarg{first-local-no} is too large.

The forth and fifth examples shows what happens when an attempt to
retrieve a mapping from a conference where the first local text numbers
have been deleted.  In the example local text numbers 1, 2 and 3 no longer
exist, and 4 corresponds to 480, and 5 to 485.

@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.
@item undefined-conference
Conference @rarg{conf-no} does not exist or is secret.
@item conference-zero
@rarg{conf-no} is zero.
@item access-denied
Conference @rarg{conf-no} is read protected.
@item no-such-local-text
@rarg{first-local-no} is higher than the highest local text number that
ever has existed in this conference.
@end table





@node get-time
@section get-time [35] (1) Recommended

@findex get-time
@example
        get-time [35] ( )
                -> ( @lt{Time} );
@end example

This call simply returns the local time according to the server.

@reqexample
@example
        1 35
        @t{=1 23 47 19 17 6 97 4 197 1}
@end example

This example demonstrates the call.  According to the server the time is
19:47:23, Thursday July 17, 1997.  The result also shows that it is the
197th day of the year, and that daylight savings time is in effect.


@subheading Error codes

This call always succeeds




@node get-info-old
@section get-info-old [36] (1) Obsolete (10)

@findex get-info-old
@example
        get-info-old [36] ( )
                -> ( @lt{Info-Old} );
@end example

This call returns the @type{Info-Old} structure for the server
(@pxref{Info-Old}).  Clients should call this in order to find
out which conferences are used for presentations and such.

This call has been superseded by @reqlink{get-info}.

This call can be issued without logging in.

@reqexample
@example
        1 36
        @t{=1 10900 1 2 3 4 1}
@end example

In this example, the server version is 1.9, the conference for
presentation of new conferences is conference 1, the conference for
presentation of new persons is conference 2, the conference for door
messages is conference 3, the LysKOM news conference is conference 4 and
the login message is text number 1.

@subheading Error codes

This call always succeeds.





@node add-footnote
@section add-footnote [37] (1) Recommended

@findex add-footnote
@example
        add-footnote [37] (( text-no    :       @lt{Text-No};
                             footnote-to:       @lt{Text-No} ))
                -> ( );
@end example

Add a footnote link between the text @rarg{footnote-to} and the text
@rarg{text-no} (@rarg{text-no} becomes a footnote to the text
@rarg{footnote-to}).  This call is used to add footnote links after a text
has been created.  Only the author of both texts is allowed to add
the footnote link.

@reqexample
@example
        1 26 1
        @t{=1 2 22 12 17 6 97 4 197 1 5 4 256 1 0 *}
        1 26 2
        @t{=1 49 49 18 17 6 97 4 197 1 5 1 52 1 2 @{ 0 2 6 1 @}}
        1 37 2 1
        @t{=1}
        1 26 1
        @t{=1 2 22 12 17 6 97 4 197 1 5 4 256 1 1 @{ 5 2 @}}
        1 26 2
        @t{=1 49 49 18 17 6 97 4 197 1 5 1 52 1}
        @t{   4 @{ 0 2 6 1 4 1 9 19 52 18 17 6 97 4 197 1 @}}
@end example

In this example, text number two is added as a footnote to text number
one.  The change is reflected in the Misc-Info List of the texts.

@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.

@item no-such-text
The text @rarg{text-no} or @rarg{footnote-to} does not exist or is
secret.

@item index-out-of-range
The @rarg{text-no} and @rarg{footnote-to} arguments are equal, and the
server does not support texts that are footnotes to themselves.

@item not-author
Not author of @rarg{footnote-to}.

@item footnote-limit
Text @rarg{footnote-to} already has the maximum number of footnotes.

@item already-footnote
Text @rarg{text-no} is already a footnote to @rarg{footnote-to}.

@item already-comment
Text @rarg{text-no} is already a comment to @rarg{footnote-to}, and a
text cannot be both a comment and a footnote to the same text.

@end table



@node sub-footnote
@section sub-footnote [38] (1) Recommended

@findex sub-footnote
@example
        sub-footnote [38] (( text-no            :       @lt{Text-No};
                             footnote-to        :       @lt{Text-No} ))
                -> ( );
@end example

This call removes the text @rarg{text-no} from @rarg{footnote-to}'s list
of footnotes.  Only the author of a footnote may remove it.

@reqexample
@example
        1 26 1
        @t{=1 2 22 12 17 6 97 4 197 1 5 4 256 1 1 @{ 5 2 @}}
        1 26 2
        @t{=1 49 49 18 17 6 97 4 197 1 5 1 52 1}
        @t{   4 @{ 0 2 6 1 4 1 9 19 52 18 17 6 97 4 197 1 @}}
        1 38 2 1
        @t{=1}
        1 26 1
        @t{=1 2 22 12 17 6 97 4 197 1 5 4 256 1 0 *}
        1 26 2
        @t{=1 49 49 18 17 6 97 4 197 1 5 1 52 1 2 @{ 0 2 6 1 @}}
@end example

In this example text 2 is a footnote to text 1, as shown by the
misc-info lists of the two texts.  The @req{sub-footnote} is called.
The misc-info lists are changed to reflect the change.

@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.
@item no-such-text
The text @rarg{text-no} or @rarg{footnote-to} does not exist or is
secret.
@item not-footnote
The text @rarg{text-no} is not a footnote to @rarg{footnote-to}.
@item permission-denied
Not supervisor of the author of @rarg{text-no} and not enough privileges
set and enabled to complete call anyway.
@end table



@node who-is-on-old
@section who-is-on-old [39] (1) Obsolete (1)

@findex who-is-on-old
@example
        who-is-on-old [39] ( )
                -> ( @lt{ARRAY} @lt{Who-Info-Old} );
@end example

This call is obsolete.  Use @reqlink{get-static-session-info} and
@reqlink{who-is-on-dynamic} instead.  If the server does not support these
calls, use @reqlink{who-is-on} instead.

The returned list contains all sessions where a person is logged in and
the invisible flag of the session is unset.

@subheading Error codes

This call always succeeds.





@node set-unread
@section set-unread [40] (1) Recommended

@findex set-unread
@example
        set-unread [40] (( conf-no      :       @lt{Conf-No};
                           no-of-unread :       @lt{INT32} ))
                -> ( );
@end example

Only read the last @rarg{no-of-unread} in the conference @rarg{conf-no}.
This call modifies the @field{last-text-read} of current person's
membership for the conference.  This call is sometimes used to
implement the ``only read last N texts'' command found in many
clients.  Due to possible race conditions@footnote{Another client might
create a new text immediately before the server processes this
@req{set-unread} call, so you might end up setting
@field{last-text-read} to something unexpected.}, this call is usually
better implemented using the @reqdlink{set-last-read} call@linkhere{}
which explicitly sets the @field{last-text-read} field of the
membership.

@reqexample
@example
        1 9 5 6
        @t{=1 1 34 21 17 6 97 4 197 1 6 100 0 0 *}
        1 40 6 0
        @t{=1}
        1 9 5 6
        @t{=1 1 34 21 17 6 97 4 197 1 6 100 4 0 *}
@end example

This example shows that person 5 last read text 0 in conference 6 (and
since 0 is an illegal local text number, that implies that the person
has not read anything in the conference.)  After calling
@req{set-unread} and asking to have zero unread texts in conference 6,
this is reflected by the call to @req{query-read-texts-old}.

@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.
@item undefined-conference
The conference @rarg{conf-no} does not exist or is secret.
@item not-member
Not a member of conference @rarg{conf-no}.
@end table



@node set-motd-of-lyskom
@section set-motd-of-lyskom [41] (1) Recommended

@findex set-motd-of-lyskom
@example
        set-motd-of-lyskom [41] ( text-no : @lt{Text-No} )
                -> ( );
@end example

This call sets the login message of LysKOM.  It can only be executed by a
privileged person, with the proper privileges enabled.  A somewhat less
convenient way of doing this is to use the @reqdlink{set-info}
call@linkhere{}.

@reqexample
@example
        1 36
        @t{=1 10900 1 2 3 4 0}
        1 41 435
        @t{=1}
        1 36
        @t{=1 10900 1 2 3 4 435}
@end example

This example shows how the login message of LysKOM is set using the
set-motd-of-lyskom call.  The results of the @req{get-info} calls
demonstrate the effect.

@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.
@item permission-denied
Administrator bit not set or privilege level not enabled.
@item no-such-text
The text @rarg{text-no} does not exist.
@item mark-limit
The text @rarg{text-no} already has the maximum number of marks.
@end table


@node enable
@section enable [42] (1) Recommended

@findex enable
@example
        enable [42] ( level : @lt{INT8} )
                -> ( );
@end example

Sets the security level for the current session to @rarg{level}.
@xref{Security}, for details about security levels.  The only levels
that make any sense right now are 0 and 255.  This call may be issued
by any person, but without the right privilege bits set, it has no
effect.

@reqexample
@example
        1 41 1
        @t{%1 12 0}
        1 42 255
        @t{=1}
        1 41 1
        @t{=1}
@end example

This example shows how @req{enable} makes a privileged call possible,
in this case a call to @reqlink{set-motd-of-lyskom}.

@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.
@end table


@node sync-kom
@section sync-kom [43] (1) Recommended

@findex sync-kom
@example
        sync-kom [43] ( )
                -> ( );
@end example

This call instructs the LysKOM server to make sure the permanent copy of
its database is current.  Processing of requests is normally blocked
until this call has completed, but the exact details depend on the
server implementation.  This call is privileged in most implementations.

@reqexample
@example
        1 42 255
        @t{=1}
        1 43
        @t{:0 7}
        @t{:0 7}
        @t{=1}
@end example

This example shows how the @reqdlink{enable} call is used to enable
all privileges@linkhere{}, then the @req{sync-kom} call is used to
save the database.  The server responds with two asynchronous messages
signaling that the database is being saved.

@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.
@item permission-denied
Administrator bit not set or privileges not enabled.
@end table


@node shutdown-kom
@section shutdown-kom [44] (1) Recommended

@findex shutdown-kom
@example
        shutdown-kom [44] ( exit-val : @lt{INT8} )
                -> ( );
@end example

This call instructs the server to save all data and shut down.
@rarg{exit-val} is currently not used.  This call is privileged.

@reqexample
@example
        1 42 255
        @t{=1}
        1 44 0
        @t{=1}
        @t{:2 13 5 3}
@end example

This example shows the shutdown of a server.  The asynchronous message
sent after the call returns is the result of a session being forced to
log out.

@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.
@item permission-denied
Administrator bit not set or privileges not enabled.
@end table


@node broadcast
@section broadcast [45] (1) Obsolete (1)

@findex broadcast
@example
        broadcast [45] ( message : @lt{HOLLERITH} )
                -> ( );
@end example

This call can been replaced by @reqlink{send-message}.  It is a privileged
call.

@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.
@item string-too-long
The string @rarg{message} is too long.
@item feature-disabled
Messages have been disabled.
@end table


@node get-membership-old
@section get-membership-old [46] (1) Obsolete (10)

@findex get-membership-old
@example
        get-membership-old [46] (( person          : @lt{Pers-No};
                                   first           : @lt{INT16};
                                   no-of-confs     : @lt{INT16};
                                   want-read-texts : @lt{BOOL} ))
                    -> ( @lt{ARRAY} @lt{Membership-Old} );
@end example

This call retrieves the membership record for a list of conferences for
a single person.  @rarg{person} is the person whose memberships are to be
retrieved.  @rarg{first} is the first position in the membership list to
retrieve, numbered from 0 and up.  @rarg{no-of-confs} is the number of
membership records to retrieve.  If @rarg{want-read-texts} is @samp{0}
the server will not send the contents of the @field{read-texts} array
of the memberships.  (The size will be transmitted, but a single
asterisk (@samp{*}) will be sent instead of the array itself.)

The server will return a membership list that is shorter than
@rarg{no-of-confs} if @rarg{no-of-confs} + @rarg{first} is larger than
the number of conferences the person is a member of.

Servers that support protocol version 10 will return a priority of zero
if the passive bit in the membership record has been set (either by a
set-membership-type or by setting the priority of the conference to
zero.)

@reqexample
@example
        1 46 5 0 3 1
        @t{=1 2 @{ 49 14 17 13 8 91 5 255 1 5 255 0 0 * }
        @t{   20 14 22 17 6 97 4 197 1 6 100 2 0 * @}}
        1 46 5 0 1 1
        @t{=1 1 @{ 49 14 17 13 8 91 5 255 1 5 255 0 0 * @}}
        1 46 5 1 4 1
        @t{=1 1 @{ 20 14 22 17 6 97 4 197 1 6 100 2 0 * @}}
@end example

In this example we retrieve the memberships of person 5.  The first
call asks for three memberships, starting with number 0.  Since this
person is only a member of two conferences, the list returned only
contains two memberships.  (An extra newline has been inserted in the
result of the first call to make the result more readable.) The next
two calls retrieve a single membership each, the first by asking for
only one, and the second by asking for four memberships, starting with
number 1.

@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.

@item undefined-person
The person @rarg{person} does not exist.

@item undefined-conference
The conference @rarg{person} does not exist or is secret.

@item index-out-of-range
@rarg{first} is higher than the index of the last conference in the
person's membership list.

@item bad-bool
@rarg{want-read-texts} must be either @samp{0} or @samp{1}.

@end table



@node get-created-texts
@section get-created-texts [47] (1) Obsolete (10)

@findex get-created-texts
@example
        get-created-texts [47] (( person        :   @lt{Pers-No};
                                  first         :   @lt{Local-Text-No};
                                  no-of-texts   :   @lt{INT32} ))
                -> ( @lt{Text-List} );
@end example

This call is obsolete; instead you should use @reqlink{map-created-texts}.

This call returns a list of the texts written by a person.
@rarg{person} is the person whose created texts are to be
retrieved.  @rarg{first} is the first text to
retrieve.  @rarg{no-of-texts} is the number of texts to retrieve.

This call is essentially the same as @reqlink{get-map}, but instead of
returning the texts sent to a single conference, it returns the texts
written by a single person to any conference.  The number of texts
written by any one person is contained in the Person record for that
person.

If @rarg{first} is lower than the first text written by @rarg{person}
that still exists, it will be automatically increased to the first still
existing text written by @rarg{person}.  The @req{get-created-texts}
will still attempt to return information about @rarg{no-of-texts} texts.
(In this regard @req{get-map} and @req{get-created-texts} differ,
since @req{get-map} will never ever return information about a later
text than specified in the arguments to the call.@footnote{This
difference was not intentional, but it is now too late to change the
semantics of either @req{get-map} or @req{get-created-texts}.
Besides, they are both obsolete calls.})

@reqexample
@example
        1 47 5 0 100
        @t{=1 1 8 @{ 1 2 3 4 5 6 7 8 @}}
        2 47 5 4 2
        @t{=2 4 2 @{ 4 5 @}}
        3 47 10 8 8
        @t{=3 12 8 @{ 309 312 324 327 329 339 0 387 @}}
@end example

In this example we have retrieved all texts written by person five.  The
first call asked for 100 texts, but only 8 were returned, which implies
that person number 5 only created a total of 8 texts.  We can also see
that person 5 wrote all the first 8 texts in the conference system.  The
second call shows how a part of the map can be retrieved.

The third call asks for eight texts written by person 10, starting with
the eighth number.  Since the first eleven texts written by that person
no longer exists the server instead returns information about eight
texts staring from the twelfth text person 10 created.  One of the eight
texts has been deleted.

@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.
@item undefined-person
The person @rarg{person} does not exist or is secret.
@item undefined-conference
The conference @rarg{person} does not exist or is secret.
@item no-such-local-text
@rarg{first} is higher than the local text number of the last created
text.
@end table



@node get-members-old
@section get-members-old [48] (1) Obsolete (10)

@findex get-members-old
@example
        get-members-old [48] (( conf            : @lt{Conf-No};
                                first           : @lt{INT16};
                                no-of-members   : @lt{INT16} ))
                -> ( @lt{ARRAY} @lt{Pers-No} );
@end example

This call returns a list of members of the conference @rarg{conf}.
@rarg{first} is the first index in the membership to return, numbered
from zero and up.  @rarg{no-of-members} is the maximum number of members
to return.

@reqexample
@example
        1 48 1 0 100
        @t{=1 4 @{ 7 8 9 10 @}}
        1 48 6 0 100
        @t{=1 4 @{ 5 7 9 10 @}}
        1 48 6 2 2
        @t{=1 2 @{ 9 10 @}}
@end example

In this example the client first requests the first 100 members in
conference 1.  The second request is for the first 100 members of
conference 6.  The last request is for members 2 and 3 in conference 6.
As can be seen from the examples, the returned list is truncated if
there are fewer members than requested.

@subheading Error codes

@table @errorcode
@item undefined-conference
The conference @rarg{conf} does not exist or is secret.
@item index-out-of-range
@rarg{first} is higher than the number of members in @rarg{conf}.
@end table



@node get-person-stat
@section get-person-stat [49] (1) Recommended

@findex get-person-stat
@example
        get-person-stat [49] ( pers-no : @lt{Pers-No} )
                -> ( @lt{Person} );
@end example

This call returns the person @rarg{pers-no}.  This call does not return
all the information a client usually needs since the name is not
included in the Person data structure.  Use @reqlink{get-conf-stat} on the
same number to get additional information about the person.

@reqexample
@example
        1 49 8
        @t{=1 @holl{44,byers@@lage.lysator.liu.se} 0000010000000000 00000000}
        @t{   44 21 19 18 6 97 5 198 1 0 2 3 0 0 0 0 0 0 1 0 0 2}
        1 50 8
        @t{=1 @holl{11,Paul Dekker} 1001 8 6 19 18 6 97 5 198 1}
        @t{   8 6 19 18 6 97 5 198 1 8 0 8 0 0 0 77 1 1 0}
@end example

This simple example shows how person number 8 is retrieved from the
server.  The second call shows the @req{get-conf-stat-old} call on the same
ID number.

@subheading Error codes

@table @errorcode
@item undefined-person
The person @rarg{pers-no} does not exist.
@item undefined-conference
The conference @rarg{pers-no} does not exist or is secret.
@end table


@node get-conf-stat-old
@section get-conf-stat-old [50] (1) Obsolete (10)

@findex get-conf-stat-old
@example
        get-conf-stat-old [50] ( conf-no : @lt{Conf-No} )
                -> ( @lt{Conference-Old} );
@end example

This call retrieves the conference data structure for conference number
@rarg{conf-no}.

Important note: This call does not return the extra flag bits that were
introduced in protocol version 8.  To get this information, use the
@req{get-uconf-stat} call instead.  However, clients should be able to
handle @type{Conference-Old} structures with an arbitrary number of flag
bits since we may decide to change the behavior of this call in the
future.

@reqexample
@example
        1 50 1
        @t{=1 @value{presconf} 0000 48 11 17 13 8 91 5 255}
        @t{   1 18 34 21 17 6 97 4 197 1 0 0 0 0 0 0 77 0 1 1}
        1 50 8
        @t{=1 @holl{11,Paul Dekker} 1001 8 6 19 18 6 97 5 198 1}
        @t{   8 6 19 18 6 97 5 198 1 8 0 8 0 0 0 77 1 1 0}
@end example

This simple example retrieves conferences 1 and 8 from the server.
Conference 1 is a regular conference, and conference 8 is a mailbox.

@subheading Error codes

@table @errorcode
@item undefined-conference
The conference @rarg{conf-no} does not exist or is secret.
@end table



@node who-is-on
@section who-is-on [51] (1) Obsolete (9)

@findex who-is-on
@example
        who-is-on [51] ( )
                -> ( @lt{ARRAY} @lt{Who-Info} );
@end example

This call is obsolete.  Please use @reqlink{who-is-on-dynamic} and
@reqdlink{get-static-session-info} calls instead@linkhere{}.
Nonetheless, servers should support this call since many clients still
use it.

This call should simply return a list of visible sessions (sessions
where a person is logged in and the invisible flag is unset).  The data
structure is described elsewhere (@pxref{Who-Info}).

@subheading Error codes

This call always succeeds.


@node get-unread-confs
@section get-unread-confs [52] (1) Recommended

@findex get-unread-confs
@example
        get-unread-confs [52] ( pers-no : @lt{Pers-No} )
                -> ( @lt{ARRAY} @lt{Conf-No} );
@end example

This call returns a list of conferences in which the person
@rarg{pers-no} may have unread texts.  This call will return a result for
any valid @rarg{pers-no}.  To retrieve information about secret persons,
or to get information about unread texts in secret conference, the
session must log on as a person with access to that information.

The result is guaranteed to include all conferences where @rarg{pers-no}
has unread texts.  It may also return some extra conferences.
Passive memberships are never returned.

The returned conference numbers will be returned in the same order as
they appear on the persons list of memberships.

@reqexample
@example
        1 52 7
        @t{=1 2 @{ 1 6 @}}
        1 52 1
        @t{%1 10 0}
        1 52 1000
        @t{%1 10 0}
@end example

This example shows how a session first retrieves the list of conferences
in which person 7 has unread texts.  The next request is for the unread
conferences of person 1, but that happens to be a conference.  The last
request is for the unread conferences of person 1000, but that person
didn't exist in the test database.


@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.
@item undefined-person
Person @rarg{pers-no} does not exist or is secret.
@end table



@node send-message
@section send-message [53] (1) Recommended

@findex send-message
@example
        send-message [53] (( recipient  :   @lt{Conf-No};
                             message    :   @lt{HOLLERITH} ))
                -> ( );
@end example

This call sends the message @rarg{message} to all members of
@rarg{recipient} using @asynclink{async-send-message}.  If
@rarg{recipient} is 0, the message is sent to all sessions that are
logged in.

The message is sent to all members of @rarg{recipient} that are
currently logged in, and where the @field{passive} and
@field{passive-message-invert} bits of the @type{Membership-Type}
(@pxref{Membership-Type}) don't prevent the message from being
delivered.

@reqexample
@example
        1 53 4 @holl{14,This is a test}
        @t{=1}
        1 53 1 @holl{14,This is a test}
        @t{:3 12 1 8 @holl{14,This is a test}}
        @t{=1}
        1 53 0 @holl{14,This is a test}
        @t{:3 12 0 8 @holl{14,This is a test}}
        @t{=1}
        1 53 5 @holl{14,This is a test}
        @t{%1 16 0}
        1 53 3 @holl{14,This is a test}
        @t{%1 42 0}
@end example

@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.
@item string-too-long
The string @rarg{message} is too long.
@item undefined-conference
Conference @rarg{recipient} does not exist or is secret.
@item feature-disabled
The message feature has been disabled in the server.
@item message-not-sent
The message was not sent for some other reason.  Perhaps the recipient is
not accepting messages or no member of the recipient was logged on.
@end table


@node get-session-info
@section get-session-info [54] (1) Obsolete (4)

@findex get-session-info
@example
        get-session-info [54] ( session-no : @lt{Session-No} )
                -> ( @lt{Session-Info} );
@end example

This call is obsolete.  It has been replaced by
@reqlink{get-session-info-ident}, which in turn is also obsolete.  See
@req{get-session-info-ident} for more information.


@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.
@item undefined-session
The session @rarg{session-no} does not exist.
@end table



@node disconnect
@section disconnect [55] (1) Recommended

@findex disconnect
@example
        disconnect [55] ( session-no : @lt{Session-No} )
                -> ( );
@end example

This call disconnects the session @rarg{session-no} from the LysKOM
server.  A session can always disconnect itself, even without logging in.
If the session is logged in as user @i{foo} it can also disconnect any
session logged in as a person for which @i{foo} is the supervisor.

Session number zero is always interpreted as the session making the
call, so the easiest way to disconnect the current session is to
disconnect session zero.

@reqexample
@example
        1 56
        @t{=1 7}
        1 55 7
        @t{=1}
        @t{:2 13 8 7}
        @t{Connection closed by foreign host.}
@end example

In this example the client asks for its own session number, then
disconnects itself (disconnection session 0 would have had the same
effect.) The asynchronous message sent just before the session is
disconnected is the logout message for the user that was logged on in
the session.  The ``Connection closed by foreign host.'' is not part of
the server output.  This message was generated by telnet.

@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call if @rarg{session-no} is not the
session issuing the call.
@item permission-denied
Attempt to disconnect another session and not supervisor of person
logged in and not enough privileges set and enabled to complete the call
anyway.
@item undefined-session
The session @rarg{session-no} does not exist.
@end table


@node who-am-i
@section who-am-i [56] (1) Recommended

@findex who-am-i
@example
        who-am-i [56] ( )
                -> ( @lt{Session-No} );
@end example

This call simply returns the session number of the session issuing the
call.

@reqexample
@example
        1 56
        @t{=1 7}
@end example

In this example the session number of the session issuing the call is
seven.

@subheading Error codes

This call always succeeds.



@node set-user-area
@section set-user-area [57] (2) Recommended

@findex set-user-area
@example
        set-user-area [57] (( pers-no   :   @lt{Pers-No};
                              user-area :   @lt{Text-No} ))
                -> ( );
@end example

This call sets the user-area field for the person @rarg{pers-no} in the
database to the text @rarg{user-area}.  The user area is used to store
client data for a particular person.  @xref{The User Area}, for more
details.

@reqexample
@example
        1 49 7
        @t{=1 @holl{25,davby@@lage.lysator.liu.se} 0000010000000000 00000000}
        @t{   6 58 21 19 6 97 6 199 1 0 458 7 3 12 7 12 0 0 3 0 0 4}
        1 57 7 11
        @t{=1}
        1 49 7
        @t{=1 @holl{25,davby@@lage.lysator.liu.se} 0000010000000000 00000000}
        @t{   6 58 21 19 6 97 6 199 1 11 458 7 71 2592 7 13 0 0 3 1 0 4}
@end example

In this example the user area of person 7 is set to text number 11.  The
original user area was text numbers zero, which means that the person
had no user area.

@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.
@item undefined-person
The person @rarg{pers-no} does not exist or is secret.
@item permission-denied
Not enough access to person @rarg{pers-no} to complete the call.
@end table


@node get-last-text
@section get-last-text [58] (3) Recommended

@findex get-last-text
@example
        get-last-text [58] ( before : @lt{Time} )
                -> ( @lt{Text-No} );
@end example

This call returns the number of the last text created before
@rarg{before}.  There is no guarantee that the text is readable by the
person making the request, or that the text even exists.

This call assumes that all texts are written in chronological order,
when the time is expressed in the local time zone of the server.  That
may not always be the case in real life.  When daylight savings time
reverts to standard time the same time span will occur twice.  The clock
of the server may also have been adjusted manually from time to time.
This protocol specification does not mandate what the server should do
in such cases.

If @reqlink{set-connection-time-format} has been used with
@code{use-utc} set to 1, the @rarg{before} time should be expressed in
UTC.  Daylight savings time will not be an issue in that case.

@reqexample
@example
        1 58 49 6 22 19 6 97 6 199 1
        @t{=1 11}
        1 58 49 6 22 18 6 97 6 199 1
        @t{=1 8}
        1 58 49 6 22 1 6 97 6 199 1
        @t{=1 0}
@end example

In this example the text created most recently before 22:06 on July 19,
1997 was text number 11; the text created most recently before 22:06 on
July 18 was text number 8; and the text created most recently before
22:06 on July 1st was text number 0, which means that there is no text
that old in the database.

@subheading Error codes

@table @errorcode

@item login-first
Login required before issuing this call.
@end table



@node create-anonymous-text-old
@section create-anonymous-text-old [59] (3) Obsolete (10)

@findex create-anonymous-text-old
@example
    create-anonymous-text-old [59] (( text      : @lt{HOLLERITH};
                                      misc-info : @lt{ARRAY} @lt{Misc-Info} ))
            -> ( @lt{Text-No} );
@end example

Similar to @reqlink{create-text-old}, but the text is created with the
@field{author} field set to zero.  Not even the server has a record of
who created the text.

The original intended use for this call was for importing texts from
other sources, such as WWW, FTP or Gopher, but some clients include
explicit support for sending anonymous texts to a server.

It is only possible to send anonymous texts to a conference with the
right flag bit set.

The only Misc-Info items valid for this call in the @rarg{misc-info}
array are @misc{recpt}, @misc{cc-recpt}, @misc{bcc-recpt} (introduced
in protocol version 10), @misc{comm-to} and @misc{footn-to}.

@reqexample
@example
        1 28 @holl{20,Example@bullet{}Message body} 3 @{ 0 5 1 112 2 33467 @}
        @t{:16 0 33502 13 16 15 16 6 97 3 196 1 0 1 20 0}
        @t{    5 @{ 0 5 6 148 1 112 6 3438 2 33467 @} }
        @t{=1 33502}
@end example

In the example, @code{@bullet{}} represents a linefeed.

In this example, person 119 creates a text containing a subject and a
one-line body.  The recipient of the text is conference five, conference
112 is a CC recipient and the text is a comment to text 33467.  The
server reply indicates that the new text has been given number 33502.
Finally there is an asynchronous message sent to all members of
recipient conferences.  Note how the message was sent before the reply to
the client.  The misc-info list in this message has two additional
fields, the local numbers of the text in each of its recipient
conferences.

@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.
@item string-too-long
The string @rarg{text} is longer than the maximum length of a message.
@item temporary-failure
The text could not be created at the moment.
@item no-such-text
Attempt to comment or footnote a non-existent or secret text.
@item not-author
Attempt to footnote a text authored by someone else.
@item footnote-limit
Attempt to footnote a text with the maximum number of footnotes already
set.
@item comment-limit
Attempt to comment a text with the maximum number of comments already
set.
@item access-denied
Attempt to send a text to a conference failed because no access to the
conference or any super conference that will accept a text.
@item anonymous-rejected
Attempt to send an anonymous text to a conference that does not accept
anonymous texts.
@item illegal-misc
Invalid misc-info list.  A recipient is listed more than once or there is
an unknown misc item in the misc-info list.
@end table




@node find-next-text-no
@section find-next-text-no [60] (3) Recommended

@findex find-next-text-no
@example
        find-next-text-no [60] ( start : @lt{Text-No} )
                -> ( @lt{Text-No} );
@end example

This call returns the next readable text in the database created after
text @rarg{start}.  @rarg{start} does not have to be a valid or readable
text number, as shown in the examples.

@reqexample
@example
        1 60 0
        @t{=1 2}
        1 60 2
        @t{=1 4}
@end example

This example shows how to retrieve the first readable text in the LysKOM
database by calling @req{find-next-text-no} with @rarg{start} set to zero.
In the example, the first text is number 2.  The second example gets the
text following number 2, which happens to be text number 4.

@subheading Error codes

@table @errorcode

@item login-first
Login required before issuing this call.

@item no-such-text
There is no text following text @rarg{start}.
@end table


@node find-previous-text-no
@section find-previous-text-no [61] (3) Recommended

@findex find-previous-text-no
@example
        find-previous-text-no [61] ( start : @lt{Text-No} )
                -> ( @lt{Text-No} );
@end example

This call returns the first readable text in the database created most
recently before @rarg{start}.  @rarg{start} does not have to be a valid
or readable text number, as shown in the examples.

@reqexample
@example
        1 61 134217727
        @t{=1 11}
        1 61 4
        @t{=1 2}
@end example

This example shows that the last readable text in the database is number
11 (unless by some odd coincidence all text from 11 to text number
134217727 have been deleted.) It also shows that the most recent text
before number 4 is text number 2.

@subheading Error codes

@table @errorcode

@item login-first
Login required before issuing this call.

@item no-such-text
There is no text preceding text @rarg{start}.
@end table



@node login
@section login [62] (4) Recommended

@findex login
@example
        login [62] (( person        :   @lt{Pers-No};
                      passwd        :   @lt{HOLLERITH};
                      invisible     :   @lt{BOOL} ))
                -> ( );
@end example

This call is used to log in.  The session is logged in as person number
@rarg{person} if @rarg{passwd} is the correct password for that person.
If @rarg{invisible} is true, the session is invisible: it will not be
returned by @reqlink{who-is-on} and @reqlink{who-is-on-ident}, and the
dynamic session info (@pxref{Dynamic-Session-Info})
will have the invisible flag set.

Invisible sessions are primarily used by software agents that do not act
on the behalf of real users.

@reqexample
@example
        1 62 7 @holl{6,gazonk} 1
        @t{=1}
        1 62 7 @holl{6,gazonk} 0
        @t{:2 9 7 1}
        1 62 7 @holl{6,gazonk} 0
        @t{:2 13 7 1}
        @t{:2 9 7 1}
        @t{=1}
@end example

This example first shows a session log in as person seven with the
invisible flag set.  Because of this the asynchronous login message is
not sent.  The second call logs in as person seven again.  This time a
login message is sent, but not a logout message since the login was
invisible.  The third example shows a third login as person 7, but this
time both the logout and login messages are sent.

@subheading Error codes

@table @errorcode
@item undefined-person
The person @rarg{person} does not exist.

@item login-disallowed
Logins have been disabled and person @rarg{person} does not have enough
privileges to override.

@item invalid-password
The password @rarg{passwd} is not the password of @rarg{person} and the
currently logged in person is not the supervisor of @rarg{person} and
does not have enough privileges set and enabled to log in anyway.

@item conference-zero
Attempt to log in as person number 0.

@item bad-bool
@rarg{invisible} must be either @samp{0} or @samp{1}.

@end table



@node who-is-on-ident
@section who-is-on-ident [63] (4) Obsolete (9)

@findex who-is-on-ident
@example
        who-is-on-ident [63] ( )
                -> ( @lt{ARRAY} @lt{Who-Info-Ident} );
@end example

This call is obsolete.  It has been replaced by
@reqlink{who-is-on-dynamic} and @reqlink{get-static-session-info}.  It
returns a list of all visible sessions.

@subheading Error codes

This call always succeeds.


@node get-session-info-ident
@section get-session-info-ident [64] (4) Obsolete (9)

@findex get-session-info-ident
@example
        get-session-info-ident [64] ( session-no : @lt{Session-No} )
                -> ( @lt{Session-Info-Ident} );
@end example

This call is obsolete.  Use @reqlink{who-is-on-dynamic} combined with
@reqlink{get-static-session-info} instead.

@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.
@item undefined-session
The session @rarg{session-no} does not exist.
@end table


@node re-lookup-person
@section re-lookup-person [65] (5) Obsolete (7)

@findex re-lookup-person
@example
        re-lookup-person [65] ( regexp : @lt{HOLLERITH} )
                -> ( @lt{ARRAY} @lt{Pers-No} );
@end example

This call is obsolete.  It has been replaced by @reqlink{re-z-lookup}.
It returns a list of persons matching the regular expression
@rarg{regexp}.  The regexp syntax used is that of the @command{ed}(1)
Unix utility.

@subheading Error codes

@table @errorcode
@item regexp-error
Error compiling the regexp @rarg{regexp}.  Perhaps the pattern is
not a correct regexp.
@end table


@node re-lookup-conf
@section re-lookup-conf [66] (5) Obsolete (7)

@findex re-lookup-conf
@example
        re-lookup-conf [66] ( regexp : @lt{HOLLERITH} )
                -> ( @lt{ARRAY} @lt{Conf-No} );
@end example

This call is obsolete.  It has been replaced by @reqlink{re-z-lookup}.  It
returns a list of conferences matching the regular expression
@rarg{regexp}.  The regexp syntax used is that of the @command{ed}(1) Unix
utility.

@subheading Error codes

@table @errorcode
@item regexp-error
Error compiling the regexp @rarg{regexp}.  Perhaps the pattern is
not a correct regexp.
@end table




@node lookup-person
@section lookup-person [67] (6) Obsolete (7)

@findex lookup-person
@example
        lookup-person [67] ( name : @lt{HOLLERITH} )
                -> ( @lt{ARRAY} @lt{Pers-No} );
@end example

This call is obsolete.  It has been replaced by @reqlink{lookup-z-name}.

This call returns a list of persons with names matching the
contracted name in @rarg{name}.  @xref{Name Expansion}, for a
description of the matching process.

@subheading Error codes

This call always succeeds.



@node lookup-conf
@section lookup-conf [68] (6) Obsolete (7)

@findex lookup-conf
@example
        lookup-conf [68] ( name : @lt{HOLLERITH} )
                -> ( @lt{ARRAY} @lt{Conf-No} );
@end example

This call is obsolete.  It has been replaced by @reqlink{lookup-z-name}.

This call returns a list of conferences with names matching the
contracted name in @rarg{name}.  @xref{Name Expansion}, for a
description of the matching process.

@subheading Error codes

This call always succeeds.



@node set-client-version
@section set-client-version [69] (6) Recommended

@findex set-client-version
@example
        set-client-version [69] (( client-name      :   @lt{HOLLERITH};
                                   client-version   :   @lt{HOLLERITH} ))
                -> ( );
@end example

This call is used to tell the server which client and which version of
that client is being used.  The name of the client is passed in
@rarg{client-name} and the version in @rarg{client-version}.  The
information sent in this call is made available to other sessions
through the @reqlink{get-client-name} and @reqdlink{get-client-version}
calls@linkhere{}.  This call should be used exactly once per session.

The following names are currently registered:

@multitable @columnfractions .3 .7
@item elisp-client     @tab     The famous CPU hog.
@item nilkom           @tab     C++ experiment
@item tkom             @tab     C++ experiment
@item getmail          @tab     Postmaster
@item ttykom           @tab     The one and second tty client by Linus
@item WinKOM           @tab     Windows client
@item JySKom           @tab     JSK Web Client
@end multitable


@reqexample
@example
        1 56
        @t{=1 7}
        2 69 @holl{11,elisp-client} @holl{4,0.45}
        @t{=2}
        3 70 7
        @t{=3 @holl{11,elisp-client}}
        4 71 7
        @t{=4 @holl{4,0.45}}
@end example

In this example the @reqdlink{who-am-i} call is used to find the ID of
the current session@linkhere{}.  Next, @req{set-client-version} is used
to set the name of the client to ``elisp-client'' and the version to
``0.45''.  The third call is to @reqdlink{get-client-name}, which
returns the string just sent to the server@linkhere{}.  Finally
@reqlink{get-client-version} is used to retrieve the client version of
session number 7, which is, as expected, the string ``0.45''.

@subheading Error codes

@table @errorcode
@item string-too-long
The string @rarg{client-name} or @rarg{client-version} is too long.

@item client-is-crazy
The client attempted to use this call more than once.  The @field{error-status}
is undefined.

@end table

@node get-client-name
@section get-client-name [70] (6) Recommended

@findex get-client-name
@example
        get-client-name [70] ( session : @lt{Session-No} )
                -> ( @lt{HOLLERITH} );
@end example

This call returns the name of the client that owns session number
@rarg{session}.  This client name string returned is the one set by the
client using @reqlink{set-client-version}.  If @req{set-client-version}
has not been issued in session number @rarg{session}, the empty string
is returned.

@xref{set-client-version}, for an example of this call.

@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.
@item undefined-session
The session @rarg{session} does not exist.
@end table


@node get-client-version
@section get-client-version [71] (6) Recommended

@findex get-client-version
@example
        get-client-version [71] ( session : @lt{Session-No} )
                -> ( @lt{HOLLERITH} );
@end example

This call returns the version of the client that owns session number
@rarg{session}.  This client version string returned is the one set by
the client using @reqlink{set-client-version}.  If
@req{set-client-version} has not been issued in session number
@rarg{session}, the empty string is returned.

@xref{set-client-version}, for an example of this call.

@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.
@item undefined-session
The session @rarg{session} does not exist.
@end table



@node mark-text
@section mark-text [72] (4) Recommended

@findex mark-text
@example
        mark-text [72] (( text      :   @lt{Text-No};
                          mark-type :   @lt{INT8} ))
                -> ( );
@end example

This call associates the mark @rarg{mark-type} with the text
@rarg{text}.  The list of marks set by a person can be retrieved using
the @reqdlink{get-marks} call@linkhere{}.

Currently, servers do not associate any particular meaning to the
different types of marks, but that may change in the future.  Currently,
servers should not delete texts that have marks, except by user request.

@reqexample
@example
        1 23
        @t{=1 0 *}
        2 72 110 230
        @t{=2}
        3 23
        @t{=3 1 @{ 110 230 @}}
@end example

This example shows how a person with no marks set sets mark 230 on text
number 110.  The calls to @reqlink{get-marks} show the effect of the call.

@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.
@item no-such-text
The text @rarg{text} does not exists or is secret.
@item permission-denied
No read access to text @rarg{text}.
@item undefined-person
The person currently logged in does not exist (can't happen error.)
@item mark-limit
Already the maximum number of marks on text @rarg{text}.
@end table




@node unmark-text
@section unmark-text [73] (6) Recommended

@findex unmark-text
@example
        unmark-text [73] ( text-no : @lt{Text-No} )
                -> ( );
@end example

This call removes any marks the logged-in person has set on the text
@rarg{text-no}.

@reqexample
@example
        1 23
        @t{=1 1 @{ 110 230 @}}
        2 73 110
        @t{=2}
        3 23
        @t{=3 0 *}
@end example

This example shows how a user with a mark set on text number 110 removes
it using the @req{unmark-text} call.

@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.
@item undefined-person
The person currently logged in does not exist (can't happen error.)
@item not-marked
The text @rarg{text-no} was not marked.
@end table


@node re-z-lookup
@section re-z-lookup [74] (7) Recommended

@findex re-z-lookup
@example
        re-z-lookup [74] (( regexp          :   @lt{HOLLERITH};
                            want-persons    :   @lt{BOOL};
                            want-confs      :   @lt{BOOL} ))
                -> ( @lt{ARRAY} @lt{Conf-Z-Info} );
@end example

This call returns a list of those conferences and/or persons matching
the regular expression @rarg{regexp}.  If @rarg{want-confs} is true, then
the result will include non-mailbox conferences.  If
@rarg{want-persons} is true, then the result will include mailbox
conferences.

See also @ref{lookup-z-name}, for an alternative way to look up names.

Refer to @ref{Name Expansion}, for more details on how name lookup
works.

@reqexample
@example
    1 74 @holl{2,.*} 1 1
    @t{=1 4 @{ @holl{15,Test Conference} 0000 10 @holl{11,David Byers} 1001 6}
    @t{        @holl{21,Trains (-) Discussion} 0000 11 @holl{4,John} 1001 9 @}}
    2 74 @holl{2,.*} 0 1
    @t{=2 2 @{ @holl{15,Test Conference} 0000 10}
    @t{       @holl{21,Trains (-) Discussion} 0000 11 @}}
    3 74 @holl{7,@badspell{T.*[cC]}} 1 1
    @t{=3 2 @{ @holl{15,Test Conference} 0000 10}
    @t{       @holl{21,Trains (-) Discussion} 0000 11 @}}
@end example

This example shows three calls to @req{re-z-lookup}.  The first call
returns all conferences and persons in the entire database, in this case
two conferences and two persons.  The second example uses the same
regular expression, but in this case, the call specifies that the
result is only to contain conferences, so the two persons are not
returned.  The third example simply returns all names matching the
pattern ``@badspell{T.*[cC]}''.

@subheading Error codes

@table @errorcode

@item regexp-error
Error compiling the regexp @rarg{regexp}.  Perhaps the pattern is
not a correct regexp.

@item bad-bool
@rarg{want-persons} and @rarg{want-confs} must be either @samp{0} or
@samp{1}.

@end table



@node get-version-info
@section get-version-info [75] (7) Recommended

@findex get-version-info
@example
        get-version-info [75] ( )
                -> ( @lt{Version-Info} );
@end example

This call returns information about the server version.  The data
returned by this call are primarily useful for presenting to the user.  A
client should not use this call to determine what the server's
capabilities are.

@reqexample
@example
        1 75
        @t{=1 9 @holl{7,lyskomd} @holl{5,1.9.0}}
@end example

This example lets us know that the server is lyskomd, version 1.9.0,
which at the time of writing this is the only really usable server.

@subheading Error codes

This call always succeeds.



@node lookup-z-name
@section lookup-z-name [76] (7) Recommended

@findex lookup-z-name
@example
        lookup-z-name [76] (( name          :   @lt{HOLLERITH};
                              want-pers     :   @lt{BOOL};
                              want-confs    :   @lt{BOOL} ))
                -> ( @lt{ARRAY} @lt{Conf-Z-Info} );
@end example

This call looks up the name @rarg{name} in the server, and returns a
list of all matching conferences and/or persons.  If @rarg{want-confs}
is true, then the result will include conferences that are not
mailboxes.  If @rarg{want-pers} is true, then the result will include
conferences that are mailboxes.

See also @ref{re-z-lookup}, for an alternative way to look up names.

Refer to @ref{Name Expansion}, for details on the matching process.

@reqexample
@example
    1 76 @holl{0,} 1 1
    @t{=1 4 @{ @holl{15,Test Conference} 0000 10 @holl{11,David Byers} 1001 6}
    @t{        @holl{21,Trains (-) Discussion} 0000 11 @holl{4,John} 1001 9 @}}
    2 76 @holl{0,} 0 1
    @t{=1 2 @{ @holl{15,Test Conference} 0000 10}
    @t{       @holl{21,Trains (-) Discussion} 0000 11 @}}
    3 76 @holl{3,T C} 1 1
    @t{=3 1 @{ @holl{15,Test Conference} 0000 10 @}}
@end example

This example shows three calls to @req{lookup-z-name}.  The first call
retrieves all conferences and persons in the server.  The second request
looks up the same name as the first, but this time the result is
restricted to conferences.  The final request requests all conferences
and persons matching the pattern ``T C''.

@subheading Error codes

@table @errorcode

@item bad-bool
@rarg{want-pers} and @rarg{want-confs} must be either @samp{0} or
@samp{1}.

@end table


@node set-last-read
@section set-last-read [77] (8) Recommended

@findex set-last-read
@example
        set-last-read [77] (( conference :   @lt{Conf-No};
                              last-read  :   @lt{Local-Text-No} ))
                -> ( );
@end example

This call tells the server that the last local text number the person
issuing the call has read in conference @rarg{conference} is
@rarg{last-read}.  This call is typically used when a user wants to have
a specific number of unread texts in a particular conference.

@reqexample
@example
        1 9 7 6
        @t{=1 2 4 22 18 6 97 5 198 1 6 100 6 0 *}
        2 77 6 3
        @t{=2}
        3 9 7 6
        @t{=3 2 4 22 18 6 97 5 198 1 6 100 3 0 *}
@end example

This example shows how person 7 originally had read everything up to and
including local text number 6 in conference 6.  After the call to
@req{set-last-read}, the @reqlink{query-read-texts-old} call reports that
person 7 has read everything up to and including local text number 3.

@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.
@item undefined-conference
The conference @rarg{conference} does not exist or is secret.
@item not-member
Not a member of conference @rarg{conference}.
@end table



@node get-uconf-stat
@section get-uconf-stat [78] (8) Recommended

@findex get-uconf-stat
@example
        get-uconf-stat [78] ( conference : @lt{Conf-No} )
                -> ( @lt{UConference} );
@end example

This call returns some information about conference @rarg{conference}.
The information it returns is sufficient for most uses of conference
information, and this call should be used instead of
@reqdlink{get-conf-stat} wherever possible@linkhere{}.  It uses less
bandwidth and the lyskomd server always keeps all @type{UConference}
objects in memory, so this call is significantly faster than
@req{get-conf-stat}.

This is also currently the only way to get all the flag bits of the
conference.

@reqexample
@example
        1 50 6
        @t{=1 @holl{8,Testconf} 0000 1 34 21 17 6 97 4 197 1}
        @t{   37 3 22 18 6 97 5 198 1 5 4 5 0 5 0 77 4 1 6}
        2 78 6
        @t{=2 @holl{8,Testconf} 00001000 6 77}
        3 50 7
        @t{=3 @holl{11,David Byers} 1111 13 4 19 18 6 97 5 198 1}
        @t{   13 4 19 18 6 97 5 198 1 7 0 7 0 0 0 77 1 1 0}
        4 78 7
        @t{=4 @holl{11,David Byers} 11111000 0 77}
@end example

This example shows the difference between @reqlink{get-conf-stat-old} and
@req{get-uconf-stat}.  In the first two examples conference 6 is
retrieved, and in the second two, conference 7, which happens to be a
person, is retrieved.  Note the difference in length of the flag field.

@subheading Error codes

@table @errorcode
@item undefined-conference
The conference @rarg{conference} does not exist or is secret.
@item conference-zero
@rarg{conference} is zero.
@end table



@node set-info
@section set-info [79] (9) Recommended

@findex set-info
@example
        set-info [79] ( info : @lt{Info-Old} )
                -> ( );
@end example

This call sets the server information retrieved by
@reqlink{get-info-old}.  The version number in the info structure is
ignored (but must be present); all other fields are stored permanently
in the LysKOM database.  This is a privileged call.

@reqexample
@example
        1 79 10901 1 2 3 4 1080
        @t{=1}
@end example

This example sets the conference presentation conference to one, the
user presentation conference to two, the motd conference to three and
the news conference to four.  It also sets the login message to text
1080.  It also attempts to set the version number to 1.9.1, but that
number is silently ignored by the server.

@subheading Error codes

@table @errorcode
@item login-first
Login required before issuing this call.

@item permission-denied
Administrator bit not set or privileges not enabled.

@item undefined-conference
One of the conferences in @rarg{info} does not exist.

@item no-such-text
The MOTD text in @rarg{info} does not exist.

@item mark-limit
The MOTD text in @rarg{info} already has the maximum number of marks.

@item text-zero
This error message should never be returned, but lyskomd 1.9.0
erroneously returned this error message if the MOTD text in @rarg{info}
was set to 0.  That should mean that there should be no message of the
day, and the current implementation of the server does accept MOTD to be
0.
@end table

@node accept-async
@section accept-async [80] (9) Recommended

@findex accept-async
@example
        accept-async [80] ( request-list : @lt{ARRAY} @lt{INT32} )
                -> ( );
@end example

This call advises the server that the client wants to receive the
asynchronous messages listed in @rarg{request-list}.  The server must
send these messages to the client when applicable, but may also send
other types of messages if it so desires.  The list of currently
requested asynchronous messages may be retrieved using the
@reqdlink{query-async} call@linkhere{}.

Don't forget that message type 12 is personal, group and global
text messages.  Most users will not want these turned off.

@reqexample
@example
        1 80 2 @{ 7 9 @}
        @t{=1}
@end example

This example tells the server that the client wants to receive
asynchronous messages when the database is being synched (message 7) and
when someone logs in (message 9).

@subheading Error codes

If the client requests a message that the server does not send, the
server will reply with an error message saying which message number it
does not support.  The call will succeed anyway.  This mechanism is useful
for clients that want new versions of some messages, but need to be
compatible with older servers.

@table @errorcode
@item unknown-async
At least one of the numbers in @rarg{request-list} is not the number
of an async message the server knows about.  The @field{error-status}
indicates the first offending number.

Please note that a bug in lyskomd 1.9.0 prevented the server from
sending this error message (frankly, we simply forgot about it.)

@item long-array
The @rarg{request-list} was too long.  Servers should always accept a
@rarg{request-list} that contains a lot more asynchronous messages