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
|
/*
* cmd_defs.c
* vim: expandtab:ts=4:sts=4:sw=4
*
* Copyright (C) 2012 - 2019 James Booth <boothj5@gmail.com>
* Copyright (C) 2019 Michael Vetter <jubalh@iodoru.org>
*
* This file is part of Profanity.
*
* Profanity is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Profanity is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Profanity. If not, see <https://www.gnu.org/licenses/>.
*
* In addition, as a special exception, the copyright holders give permission to
* link the code of portions of this program with the OpenSSL library under
* certain conditions as described in each individual source file, and
* distribute linked combinations including the two.
*
* You must obey the GNU General Public License in all respects for all of the
* code used other than OpenSSL. If you modify file(s) with this exception, you
* may extend this exception to your version of the file(s), but you are not
* obligated to do so. If you do not wish to do so, delete this exception
* statement from your version. If you delete this exception statement from all
* source files in the program, then also delete it here.
*
*/
#include "config.h"
#include <assert.h>
#include <errno.h>
#include <limits.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <libgen.h>
#include <dirent.h>
#include <sys/types.h>
#include <glib.h>
#include "profanity.h"
#include "log.h"
#include "common.h"
#include "command/cmd_defs.h"
#include "command/cmd_funcs.h"
#include "command/cmd_ac.h"
#include "config/accounts.h"
#include "config/preferences.h"
#include "config/theme.h"
#include "config/tlscerts.h"
#include "config/scripts.h"
#include "plugins/plugins.h"
#include "tools/autocomplete.h"
#include "tools/parser.h"
#include "ui/ui.h"
#include "ui/window_list.h"
#include "xmpp/xmpp.h"
#include "xmpp/contact.h"
#include "xmpp/roster_list.h"
#include "xmpp/jid.h"
#include "xmpp/chat_session.h"
#include "xmpp/muc.h"
#ifdef HAVE_LIBOTR
#include "otr/otr.h"
#endif
#ifdef HAVE_LIBGPGME
#include "pgp/gpg.h"
#endif
#define CMD_TAG_CHAT "chat"
#define CMD_TAG_GROUPCHAT "groupchat"
#define CMD_TAG_ROSTER "roster"
#define CMD_TAG_PRESENCE "presence"
#define CMD_TAG_CONNECTION "connection"
#define CMD_TAG_DISCOVERY "discovery"
#define CMD_TAG_UI "ui"
#define CMD_TAG_PLUGINS "plugins"
#define CMD_MAINFUNC(func) func,
#define CMD_NOMAINFUNC NULL,
#define CMD_SUBFUNCS(...) { __VA_ARGS__, { NULL, NULL } },
#define CMD_NOSUBFUNCS { { NULL, NULL } },
#define CMD_NOTAGS \
{ \
{ NULL },
#define CMD_TAGS(...) \
{ \
{ __VA_ARGS__, NULL },
#define CMD_SYN(...) { __VA_ARGS__, NULL },
#define CMD_DESC(desc) desc,
#define CMD_NOARGS { { NULL, NULL } },
#define CMD_ARGS(...) { __VA_ARGS__, { NULL, NULL } },
#define CMD_NOEXAMPLES \
{ \
NULL \
} \
}
#define CMD_EXAMPLES(...) \
{ \
__VA_ARGS__, NULL \
} \
}
GHashTable* commands = NULL;
static gboolean _cmd_has_tag(Command* pcmd, const char* const tag);
/*
* Command list
*/
// clang-format off
static struct cmd_t command_defs[] = {
{ "/help",
parse_args_with_freetext, 0, 2, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_help)
CMD_NOTAGS
CMD_SYN(
"/help [<area>|<command>|search_all|search_any] [<search_terms>]")
CMD_DESC(
"Help on using Profanity. Passing no arguments list help areas. "
"For command help, optional arguments are shown using square brackets, "
"arguments representing variables rather than a literal name are surrounded by angle brackets. "
"Arguments that may be one of a number of values are separated by a pipe "
"e.g. val1|val2|val3.")
CMD_ARGS(
{ "<area>", "Summary help for commands in a certain area of functionality." },
{ "<command>", "Full help for a specific command, for example '/help connect'." },
{ "search_all <search_terms>", "Search commands for returning matches that contain all of the search terms." },
{ "search_any <search_terms>", "Search commands for returning matches that contain any of the search terms." })
CMD_EXAMPLES(
"/help search_all presence online",
"/help commands",
"/help presence",
"/help who")
},
{ "/about",
parse_args, 0, 0, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_about)
CMD_NOTAGS
CMD_SYN(
"/about")
CMD_DESC(
"Show version and license information.")
CMD_NOARGS
CMD_NOEXAMPLES
},
{ "/connect",
parse_args, 0, 7, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_connect)
CMD_TAGS(
CMD_TAG_CONNECTION)
CMD_SYN(
"/connect [<account>]",
"/connect <account> [server <server>] [port <port>] [tls force|allow|trust|legacy|disable] [auth default|legacy]")
CMD_DESC(
"Login to a chat service. "
"If no account is specified, the default is used if one is configured. "
"A local account is created with the JID as it's name if it doesn't already exist.")
CMD_ARGS(
{ "<account>", "The local account you wish to connect with, or a JID if connecting for the first time." },
{ "server <server>", "Supply a server if it is different to the domain part of your JID." },
{ "port <port>", "The port to use if different to the default (5222, or 5223 for SSL)." },
{ "tls force", "Force TLS connection, and fail if one cannot be established, this is default behaviour." },
{ "tls allow", "Use TLS for the connection if it is available." },
{ "tls trust", "Force TLS connection and trust server's certificate." },
{ "tls legacy", "Use legacy TLS for the connection. It means server doesn't support STARTTLS and TLS is forced just after TCP connection is established." },
{ "tls disable", "Disable TLS for the connection." },
{ "auth default", "Default authentication process." },
{ "auth legacy", "Allow legacy authentication." })
CMD_EXAMPLES(
"/connect",
"/connect odin@valhalla.edda",
"/connect odin@valhalla.edda server talk.google.com",
"/connect freyr@vanaheimr.edda port 5678",
"/connect me@localhost.test.org server 127.0.0.1 tls disable",
"/connect me@chatty server chatty.com port 5443")
},
{ "/tls",
parse_args, 1, 3, NULL,
CMD_SUBFUNCS(
{ "certpath", cmd_tls_certpath },
{ "trust", cmd_tls_trust },
{ "trusted", cmd_tls_trusted },
{ "revoke", cmd_tls_revoke },
{ "cert", cmd_tls_cert })
CMD_NOMAINFUNC
CMD_TAGS(
CMD_TAG_CONNECTION,
CMD_TAG_UI)
CMD_SYN(
"/tls allow",
"/tls always",
"/tls deny",
"/tls cert [<fingerprint>]",
"/tls trust",
"/tls trusted",
"/tls revoke <fingerprint>",
"/tls certpath",
"/tls certpath set <path>",
"/tls certpath clear",
"/tls certpath default")
CMD_DESC(
"Handle TLS certificates. ")
CMD_ARGS(
{ "allow", "Allow connection to continue with TLS certificate." },
{ "always", "Always allow connections with TLS certificate." },
{ "deny", "Abort connection." },
{ "cert", "Show the current TLS certificate." },
{ "cert <fingerprint>", "Show details of trusted certificate." },
{ "trust", "Add the current TLS certificate to manually trusted certificates." },
{ "trusted", "List summary of manually trusted certificates (with '/tls always' or '/tls trust')." },
{ "revoke <fingerprint>", "Remove a manually trusted certificate." },
{ "certpath", "Show the trusted certificate path." },
{ "certpath set <path>", "Specify filesystem path containing trusted certificates." },
{ "certpath clear", "Clear the trusted certificate path." },
{ "certpath default", "Use default system certificate path, if it can be found." })
CMD_NOEXAMPLES
},
{ "/disconnect",
parse_args, 0, 0, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_disconnect)
CMD_TAGS(
CMD_TAG_CONNECTION)
CMD_SYN(
"/disconnect")
CMD_DESC(
"Disconnect from the current chat service.")
CMD_NOARGS
CMD_NOEXAMPLES
},
{ "/msg",
parse_args_with_freetext, 1, 2, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_msg)
CMD_TAGS(
CMD_TAG_CHAT)
CMD_SYN(
"/msg <contact> [<message>]",
"/msg <nick> [<message>]")
CMD_DESC(
"Send a one to one chat message, or a private message to a chat room occupant. "
"If the message is omitted, a new chat window will be opened without sending a message. "
"Use quotes if the nickname includes spaces.")
CMD_ARGS(
{ "<contact>", "Open chat window with contact, by JID or nickname." },
{ "<contact> [<message>]", "Send message to contact, by JID or nickname." },
{ "<nick>", "Open private chat window with chat room occupant." },
{ "<nick> [<message>]", "Send a private message to a chat room occupant." })
CMD_EXAMPLES(
"/msg thor@valhalla.edda Hey, here's a message!",
"/msg heimdall@valhalla.edda",
"/msg Thor Here is a private message",
"/msg \"My Friend\" Hi, how are you?")
},
{ "/roster",
parse_args_with_freetext, 0, 4, NULL,
CMD_SUBFUNCS(
{ "group", cmd_group })
CMD_MAINFUNC(cmd_roster)
CMD_TAGS(
CMD_TAG_ROSTER,
CMD_TAG_UI)
CMD_SYN(
"/roster",
"/roster online",
"/roster show [offline|resource|presence|status|empty|priority|contacts|rooms]",
"/roster hide [offline|resource|presence|status|empty|priority|contacts|rooms]",
"/roster by group|presence|none",
"/roster count unread|items|off",
"/roster count zero on|off",
"/roster color on|off",
"/roster order name|presence",
"/roster unread before|after|off",
"/roster room char <char>|none",
"/roster room private char <char>|none",
"/roster room position first|last",
"/roster room by service|none",
"/roster room order name|unread",
"/roster room unread before|after|off",
"/roster room show server",
"/roster room hide server",
"/roster room use name|jid",
"/roster private room|group|off",
"/roster private char <char>|none",
"/roster header char <char>|none",
"/roster presence indent <indent>",
"/roster contact char <char>|none",
"/roster contact indent <indent>",
"/roster resource char <char>|none",
"/roster resource indent <indent>",
"/roster resource join on|off",
"/roster size <percent>",
"/roster wrap on|off",
"/roster add <jid> [<nick>]",
"/roster remove <jid>",
"/roster remove_all contacts",
"/roster nick <jid> <nick>",
"/roster clearnick <jid>",
"/roster group",
"/roster group show <group>",
"/roster group add <group> <contat>",
"/roster group remove <group> <contact>")
CMD_DESC(
"Manage your roster, and roster display settings. "
"Passing no arguments lists all contacts in your roster.")
CMD_ARGS(
{ "online", "Show all online contacts in console." },
{ "show", "Show the roster panel." },
{ "show offline", "Show offline contacts in roster panel." },
{ "show resource", "Show contact's connected resources in roster panel." },
{ "show presence", "Show contact's presence in roster panel." },
{ "show status", "Show contact's status message in roster panel." },
{ "show empty", "Show empty groups in roster panel." },
{ "show priority", "Show resource priority in roster panel." },
{ "show contacts", "Show contacts in roster panel." },
{ "show rooms", "Show chat rooms in roster panel." },
{ "hide", "Hide the roster panel." },
{ "hide offline", "Hide offline contacts in roster panel." },
{ "hide resource", "Hide contact's connected resources in roster panel." },
{ "hide presence", "Hide contact's presence in roster panel." },
{ "hide status", "Hide contact's status message in roster panel." },
{ "hide empty", "Hide empty groups in roster panel." },
{ "hide priority", "Hide resource priority in roster panel." },
{ "hide contacts", "Hide contacts in roster panel." },
{ "hide rooms", "Hide chat rooms in roster panel." },
{ "by group", "Group contacts in roster panel by roster group." },
{ "by presence", "Group contacts in roster panel by presence." },
{ "by none", "No grouping in roster panel." },
{ "count unread", "Show unread message count with roster headers." },
{ "count items", "Show item count with roster headers." },
{ "count off", "Do not show any count with roster headers." },
{ "count zero on", "Show roster header count when 0." },
{ "count zero off", "Hide roster header count when 0." },
{ "color on", "Enable generated color names (XEP-0392)" },
{ "color off", "Disable generated color names (XEP-0392)" },
{ "order name", "Order roster contacts by name only." },
{ "order presence", "Order roster contacts by presence, and then by name." },
{ "unread before", "Show unread message count before contact." },
{ "unread after", "Show unread message count after contact." },
{ "unread off", "Do not show unread message count for contacts." },
{ "room char <char>", "Prefix rooms with specified character." },
{ "room char none", "Remove room character prefix." },
{ "room private char <char>", "Prefix private room chat with specified character when displayed with room." },
{ "room private char none", "Remove private room chat character prefix when displayed with room." },
{ "room position first", "Show rooms first in roster." },
{ "room position last", "Show rooms last in roster." },
{ "room by service", "Group rooms by chat service." },
{ "room by none", "Do not group rooms." },
{ "room order name", "Order rooms by name." },
{ "room order unread", "Order rooms by unread messages, and then by name." },
{ "room unread before", "Show unread message count before room." },
{ "room unread after", "Show unread message count after room." },
{ "room unread off", "Do not show unread message count for rooms." },
{ "room show server", "Show the conference server with room JIDs." },
{ "room hide server", "Do not show the conference server with room JIDs." },
{ "room use name", "Use the MUC name as room name." },
{ "room use jid", "Use the JID as room name." },
{ "private room", "Show room private chats with the room." },
{ "private group", "Show room private chats as a separate roster group." },
{ "private off", "Do not show room private chats." },
{ "private char <char>", "Prefix private room chats with specified character when displayed in separate group." },
{ "private char none", "Remove private room chat character prefix." },
{ "header char <char>", "Prefix roster headers with specified character." },
{ "header char none", "Remove roster header character prefix." },
{ "contact char <char>", "Prefix roster contacts with specified character." },
{ "contact char none", "Remove roster contact character prefix." },
{ "contact indent <indent>", "Indent contact line by <indent> spaces (0 to 10)." },
{ "resource char <char>", "Prefix roster resources with specified character." },
{ "resource char none", "Remove roster resource character prefix." },
{ "resource indent <indent>", "Indent resource line by <indent> spaces (0 to 10)." },
{ "resource join on|off", "Join resource with previous line when only one available resource." },
{ "presence indent <indent>", "Indent presence line by <indent> spaces (-1 to 10), a value of -1 will show presence on the previous line." },
{ "size <percent>", "Percentage of the screen taken up by the roster (1-99)." },
{ "wrap on|off", "Enable or disable line wrapping in roster panel." },
{ "add <jid> [<nick>]", "Add a new item to the roster." },
{ "remove <jid>", "Removes an item from the roster." },
{ "remove_all contacts", "Remove all items from roster." },
{ "nick <jid> <nick>", "Change a contacts nickname." },
{ "clearnick <jid>", "Removes the current nickname." },
{ "group show <group>", "List all roster items in a group." },
{ "group add <group> <contact>", "Add a contact to a group." },
{ "group remove <group> <contact>", "Remove a contact from a group." })
CMD_EXAMPLES(
"/roster",
"/roster add odin@valhalla.edda",
"/roster add odin@valhalla.edda Allfather",
"/roster remove loki@ownserver.org",
"/roster nick odin@valhalla.edda \"All Father\"",
"/roster clearnick thor@valhalla.edda",
"/roster size 15",
"/roster group",
"/roster group show friends",
"/roster group add friends fenris@ownserver.org",
"/roster group add family Brother",
"/roster group remove colleagues boss@work.com")
},
{ "/blocked",
parse_args, 0, 2, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_blocked)
CMD_TAGS(
CMD_TAG_ROSTER,
CMD_TAG_CHAT)
CMD_SYN(
"/blocked",
"/blocked add [<jid>]",
"/blocked remove <jid>")
CMD_DESC(
"Manage blocked users (XEP-0191), calling with no arguments shows the current list of blocked users. "
"To blog a certain user in a MUC use the following as jid: room@conference.example.org/spammy-user")
CMD_ARGS(
{ "add [<jid>]", "Block the specified Jabber ID. If in a chat window and no jid is specified, the current recipient will be blocked." },
{ "remove <jid>", "Remove the specified Jabber ID from the blocked list." })
CMD_EXAMPLES(
"/blocked add hel@helheim.edda",
"/blocked add profanity@rooms.dismail.de/spammy-user")
},
{ "/info",
parse_args, 0, 1, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_info)
CMD_TAGS(
CMD_TAG_ROSTER,
CMD_TAG_CHAT,
CMD_TAG_GROUPCHAT)
CMD_SYN(
"/info",
"/info <contact>|<nick>")
CMD_DESC(
"Show information about a contact, room, or room member. "
"Passing no argument in a chat window will use the current recipient. "
"Passing no argument in a chat room will display information about the room.")
CMD_ARGS(
{ "<contact>", "The contact you wish to view information about." },
{ "<nick>", "When in a chat room, the occupant you wish to view information about." })
CMD_EXAMPLES(
"/info thor@aasgard.server.org",
"/info heimdall")
},
{ "/caps",
parse_args, 0, 1, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_caps)
CMD_TAGS(
CMD_TAG_DISCOVERY,
CMD_TAG_CHAT,
CMD_TAG_GROUPCHAT)
CMD_SYN(
"/caps",
"/caps <fulljid>|<nick>")
CMD_DESC(
"Find out a contacts, or room members client software capabilities. "
"If in private chat initiated from a chat room, no parameter is required.")
CMD_ARGS(
{ "<fulljid>", "If in the console or a chat window, the full JID for which you wish to see capabilities." },
{ "<nick>", "If in a chat room, nickname for which you wish to see capabilities." })
CMD_EXAMPLES(
"/caps ran@cold.sea.org/laptop",
"/caps ran@cold.sea.org/phone",
"/caps aegir")
},
{ "/software",
parse_args, 0, 1, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_software)
CMD_TAGS(
CMD_TAG_DISCOVERY,
CMD_TAG_CHAT,
CMD_TAG_GROUPCHAT)
CMD_SYN(
"/software",
"/software <fulljid>|<nick>")
CMD_DESC(
"Find out a contact, or room members software version information. "
"If in private chat initiated from a chat room, no parameter is required. "
"If the contact's software does not support software version requests, nothing will be displayed.")
CMD_ARGS(
{ "<fulljid>", "If in the console or a chat window, the full JID for which you wish to see software information." },
{ "<nick>", "If in a chat room, nickname for which you wish to see software information." })
CMD_EXAMPLES(
"/software odin@valhalla.edda/laptop",
"/software odin@valhalla.edda/phone",
"/software thor")
},
{ "/status",
parse_args, 2, 3, NULL,
CMD_SUBFUNCS(
{ "get", cmd_status_get },
{ "set", cmd_status_set })
CMD_NOMAINFUNC
CMD_TAGS(
CMD_TAG_CHAT,
CMD_TAG_GROUPCHAT)
CMD_SYN(
"/status set <state> [\"<message>\"]",
"/status get <contact>|<nick>")
CMD_DESC(
"/status get: Find out a contact, or room members presence information. "
"/status set: set own status.")
CMD_ARGS(
{ "<state>", "Own status. Possible values: chat, online, away, dnd, xa" },
{ "<message>", "Optional message to use with the status. Needs quotation marks if it's more than one word." },
{ "<contact>", "The contact who's presence you which to see." },
{ "<nick>", "If in a chat room, the occupant who's presence you wish to see." })
CMD_EXAMPLES(
"/status get odin@valhalla.edda",
"/status get jon",
"/status set online")
},
{ "/resource",
parse_args, 1, 2, &cons_resource_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_resource)
CMD_TAGS(
CMD_TAG_CHAT,
CMD_TAG_UI)
CMD_SYN(
"/resource set <resource>",
"/resource off",
"/resource title on|off",
"/resource message on|off")
CMD_DESC(
"Override chat session resource, and manage resource display settings.")
CMD_ARGS(
{ "set <resource>", "Set the resource to which messages will be sent." },
{ "off", "Let the server choose which resource to route messages to." },
{ "title on|off", "Show or hide the current resource in the titlebar." },
{ "message on|off", "Show or hide the resource when showing an incoming message." })
CMD_NOEXAMPLES
},
{ "/join",
parse_args, 0, 5, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_join)
CMD_TAGS(
CMD_TAG_GROUPCHAT)
CMD_SYN(
"/join",
"/join <room> [nick <nick>] [password <password>]")
CMD_DESC(
"Join a chat room at the conference server. "
"If no room is supplied, a generated name will be used with the format private-chat-[UUID]. "
"If the domain part is not included in the room name, the account preference 'muc.service' will be used. "
"If no nickname is specified the account preference 'muc.nick' will be used which by default is the localpart of your JID. "
"If the room doesn't exist, and the server allows it, a new one will be created. "
"If you join to a room often, you might also want to add a bookmark (see `/help bookmark`), which also allows to set a default nickname. "
"In this case, you should use `/bookmark join`.")
CMD_ARGS(
{ "<room>", "The chat room to join." },
{ "nick <nick>", "Nickname to use in the room." },
{ "password <password>", "Password if the room requires one." })
CMD_EXAMPLES(
"/join",
"/join profanity@rooms.dismail.de",
"/join profanity@rooms.dismail.de nick mynick",
"/join private@conference.jabber.org nick mynick password mypassword",
"/join mychannel")
},
{ "/invite",
parse_args_with_freetext, 1, 3, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_invite)
CMD_TAGS(
CMD_TAG_GROUPCHAT)
CMD_SYN(
"/invite send <contact> [<message>]",
"/invite list",
"/invite decline")
CMD_DESC(
"Manage room invites. "
"Send an invite to a contact for the current chat room. "
"List received invites. "
"Decline them using /invite decline and accept them using /join.")
CMD_ARGS(
{ "send <contact> [<message>]", "The contact you wish to invite. And an optional message." },
{ "list", "Show all rooms that you have been invited to, and not accepted or declined." },
{ "decline <room>", "Decline a chat room invitation." })
CMD_EXAMPLES(
"/invite send gustavo@pollos.tx",
"/invite decline profanity@rooms.dismail.de",
"/invite list")
},
{ "/room",
parse_args, 1, 1, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_room)
CMD_TAGS(
CMD_TAG_GROUPCHAT)
CMD_SYN(
"/room accept|destroy|config")
CMD_DESC(
"Chat room configuration.")
CMD_ARGS(
{ "accept", "Accept default room configuration." },
{ "destroy", "Reject default room configuration, and destroy the room." },
{ "config", "Edit room configuration." })
CMD_NOEXAMPLES
},
{ "/kick",
parse_args_with_freetext, 1, 2, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_kick)
CMD_TAGS(
CMD_TAG_GROUPCHAT)
CMD_SYN(
"/kick <nick> [<reason>]")
CMD_DESC(
"Kick occupant from chat room.")
CMD_ARGS(
{ "<nick>", "Nickname of the occupant to kick from the room." },
{ "<reason>", "Optional reason for kicking the occupant." })
CMD_NOEXAMPLES },
{ "/ban",
parse_args_with_freetext, 1, 2, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_ban)
CMD_TAGS(
CMD_TAG_GROUPCHAT)
CMD_SYN(
"/ban <jid> [<reason>]")
CMD_DESC(
"Ban user from chat room.")
CMD_ARGS(
{ "<jid>", "Bare JID of the user to ban from the room." },
{ "<reason>", "Optional reason for banning the user." })
CMD_NOEXAMPLES
},
{ "/subject",
parse_args_with_freetext, 0, 2, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_subject)
CMD_TAGS(
CMD_TAG_GROUPCHAT)
CMD_SYN(
"/subject set <subject>",
"/subject edit <subject>",
"/subject prepend <text>",
"/subject append <text>",
"/subject clear")
CMD_DESC(
"Set, modify, or clear room subject.")
CMD_ARGS(
{ "set <subject>", "Set the room subject." },
{ "edit <subject>", "Edit the current room subject, tab autocompletion will display the subject to edit." },
{ "prepend <text>", "Prepend text to the current room subject, use double quotes if a trailing space is needed." },
{ "append <text>", "Append text to the current room subject, use double quotes if a preceding space is needed." },
{ "clear", "Clear the room subject." })
CMD_NOEXAMPLES
},
{ "/affiliation",
parse_args_with_freetext, 1, 4, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_affiliation)
CMD_TAGS(
CMD_TAG_GROUPCHAT)
CMD_SYN(
"/affiliation set <affiliation> <jid> [<reason>]",
"/affiliation list [<affiliation>]",
"/affiliation request",
"/affiliation register")
CMD_DESC(
"Manage room affiliations. "
"Affiliation may be one of owner, admin, member, outcast or none.")
CMD_ARGS(
{ "set <affiliation> <jid> [<reason>]", "Set the affiliation of user with jid, with an optional reason." },
{ "list [<affiliation>]", "List all users with the specified affiliation, or all if none specified." },
{ "request", "Request voice."},
{ "register", "Register your nickname with the MUC."})
CMD_NOEXAMPLES
},
{ "/role",
parse_args_with_freetext, 1, 4, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_role)
CMD_TAGS(
CMD_TAG_GROUPCHAT)
CMD_SYN(
"/role set <role> <nick> [<reason>]",
"/role list [<role>]")
CMD_DESC(
"Manage room roles. "
"Role may be one of moderator, participant, visitor or none.")
CMD_ARGS(
{ "set <role> <nick> [<reason>]", "Set the role of occupant with nick, with an optional reason." },
{ "list [<role>]", "List all occupants with the specified role, or all if none specified." })
CMD_NOEXAMPLES
},
{ "/occupants",
parse_args, 1, 3, cons_occupants_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_occupants)
CMD_TAGS(
CMD_TAG_GROUPCHAT,
CMD_TAG_UI)
CMD_SYN(
"/occupants show|hide [jid|offline]",
"/occupants char <char>|none",
"/occupants color on|off",
"/occupants default show|hide [jid|offline]",
"/occupants size [<percent>]",
"/occupants indent <indent>",
"/occupants header char <char>|none",
"/occupants wrap on|off")
CMD_DESC(
"Show or hide room occupants, and occupants panel display settings.")
CMD_ARGS(
{ "show", "Show the occupants panel in current room." },
{ "char <char>", "Prefix occupants with specified character." },
{ "char none", "Remove occupants character prefix." },
{ "color on", "Enable generated color names (XEP-0392) for occupants" },
{ "color off", "Disable generated color names (XEP-0392) for occupants" },
{ "hide", "Hide the occupants panel in current room." },
{ "show jid", "Show jid in the occupants panel in current room." },
{ "hide jid", "Hide jid in the occupants panel in current room." },
{ "show offline", "Show offline occupants panel in current room." },
{ "hide offline", "Hide offline occupants panel in current room." },
{ "default show|hide", "Whether occupants are shown by default in new rooms." },
{ "default show|hide jid", "Whether occupants jids are shown by default in new rooms." },
{ "default show|hide offline", "Whether offline occupants are shown by default in new rooms." },
{ "size <percent>", "Percentage of the screen taken by the occupants list in rooms (1-99)." },
{ "indent <indent>", "Indent contact line by <indent> spaces (0 to 10)." },
{ "header char <char>", "Prefix occupants headers with specified character." },
{ "header char none", "Remove occupants header character prefix." },
{ "wrap on|off", "Enable or disable line wrapping in occupants panel." })
CMD_NOEXAMPLES
},
{ "/form",
parse_args, 1, 2, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_form)
CMD_TAGS(
CMD_TAG_GROUPCHAT)
CMD_SYN(
"/form show",
"/form submit",
"/form cancel",
"/form help [<tag>]")
CMD_DESC(
"Form configuration.")
CMD_ARGS(
{ "show", "Show the current form." },
{ "submit", "Submit the current form." },
{ "cancel", "Cancel changes to the current form." },
{ "help [<tag>]", "Display help for form, or a specific field." })
CMD_NOEXAMPLES
},
{ "/rooms",
parse_args, 0, 4, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_rooms)
CMD_TAGS(
CMD_TAG_GROUPCHAT)
CMD_SYN(
"/rooms",
"/rooms filter <text>",
"/rooms service <service>",
"/rooms service <service> filter <text>",
"/rooms cache on|off|clear")
CMD_DESC(
"List the chat rooms available at the specified conference service. "
"If no argument is supplied, the account preference 'muc.service' is used, 'conference.<domain-part>' by default. "
"The filter argument only shows rooms that contain the provided text, case insensitive.")
CMD_ARGS(
{ "service <service>", "The conference service to query." },
{ "filter <text>", "The text to filter results by." },
{ "cache on|off", "Enable or disable caching of rooms list response, enabled by default." },
{ "cache clear", "Clear the rooms response cache if enabled." })
CMD_EXAMPLES(
"/rooms",
"/rooms filter development",
"/rooms service conference.jabber.org",
"/rooms service conference.jabber.org filter \"News Room\"")
},
{ "/bookmark",
parse_args, 0, 8, NULL,
CMD_SUBFUNCS(
{ "ignore", cmd_bookmark_ignore })
CMD_MAINFUNC(cmd_bookmark)
CMD_TAGS(
CMD_TAG_GROUPCHAT)
CMD_SYN(
"/bookmark",
"/bookmark list",
"/bookmark add [<room>] [nick <nick>] [password <password>] [name <roomname>] [autojoin on|off]",
"/bookmark update <room> [nick <nick>] [password <password>] [name <roomname>] [autojoin on|off]",
"/bookmark remove [<room>]",
"/bookmark join <room>",
"/bookmark invites on|off",
"/bookmark ignore",
"/bookmark ignore add <jid>",
"/bookmark ignore remove <jid>")
CMD_DESC(
"Manage bookmarks and join bookmarked rooms. "
"If you are in a chat room and no arguments are supplied to `/bookmark add`, autojoin is set to \"on\". "
"There is also an autojoin ignore list in case you want to autojoin in many clients but not on Profanity. ")
CMD_ARGS(
{ "list", "List all bookmarks." },
{ "add [<room>]", "Add a bookmark, passing no room will bookmark the current room, setting autojoin to \"on\"." },
{ "remove [<room>]", "Remove a bookmark, passing no room will remove the bookmark for the current room, if one exists." },
{ "update <room>", "Update the properties associated with a bookmark." },
{ "nick <nick>", "Nickname used when joining the chat room." },
{ "password <password>", "Password if required, may be stored in plaintext on your server." },
{ "name <roomname>", "Optional name for the bookmark. By default localpart of the JID will be used." },
{ "autojoin on|off", "Whether to join the room automatically on login." },
{ "join <room>", "Join room using the properties associated with the bookmark." },
{ "invites on|off", "Whether or not to bookmark accepted room invites, defaults to 'on'." },
{ "ignore add <barejid>", "Add a bookmark to the autojoin ignore list." },
{ "ignore remove <barejid>", "Remove a bookmark from the autojoin ignore list." })
CMD_EXAMPLES(
"/bookmark add room@example.com nick YOURNICK",
"/bookmark join room@example.com",
"/bookmark update room@example.com nick NEWNICK autojoin on",
"/bookmark ignore room@example.com",
"/bookmark remove room@example.com")
},
{ "/disco",
parse_args, 1, 2, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_disco)
CMD_TAGS(
CMD_TAG_DISCOVERY)
CMD_SYN(
"/disco info [<jid>]",
"/disco items [<jid>]")
CMD_DESC(
"Find out information about an entities supported services. "
"Calling with no arguments will query the server you are currently connected to.")
CMD_ARGS(
{ "info [<jid>]", "List protocols and features supported by an entity." },
{ "items [<jid>]", "List items associated with an entity." })
CMD_EXAMPLES(
"/disco info",
"/disco items myserver.org",
"/disco items conference.jabber.org",
"/disco info odin@valhalla.edda/laptop")
},
{ "/sendfile",
parse_args_with_freetext, 1, 1, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_sendfile)
CMD_TAGS(
CMD_TAG_CHAT,
CMD_TAG_GROUPCHAT)
CMD_SYN(
"/sendfile <file>")
CMD_DESC(
"Send a file using XEP-0363 HTTP file transfer.")
CMD_ARGS(
{ "<file>", "Path to the file." })
CMD_EXAMPLES(
"/sendfile /etc/hosts",
"/sendfile ~/images/sweet_cat.jpg")
},
{ "/lastactivity",
parse_args, 1, 2, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_lastactivity)
CMD_TAGS(
CMD_TAG_PRESENCE)
CMD_SYN(
"/lastactivity set on|off",
"/lastactivity get [<jid>]")
CMD_DESC(
"Enable/disable sending last activity, and send last activity requests.")
CMD_ARGS(
{ "on|off", "Enable or disable sending of last activity." },
{ "<jid>", "The JID of the entity to query. Omitting the JID will query your server for its uptime." })
CMD_EXAMPLES(
"/lastactivity get",
"/lastactivity set off",
"/lastactivity get freyja@asgaard.edda",
"/lastactivity get freyja@asgaard.edda/laptop",
"/lastactivity get someserver.com")
},
{ "/nick",
parse_args_with_freetext, 1, 1, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_nick)
CMD_TAGS(
CMD_TAG_GROUPCHAT)
CMD_SYN(
"/nick <nickname>")
CMD_DESC(
"Change your nickname in the current chat room.")
CMD_ARGS(
{ "<nickname>", "Your new nickname." })
CMD_NOEXAMPLES
},
{ "/win",
parse_args, 1, 1, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_win)
CMD_TAGS(
CMD_TAG_UI)
CMD_SYN(
"/win console",
"/win <num>",
"/win <barejid>",
"/win <nick>",
"/win <roomjid>",
"/win <roomoccupantjid>",
"/win xmlconsole",
"/win <plugin>")
CMD_DESC(
"Move to the specified window.")
CMD_ARGS(
{ "console", "Focus the Console window." },
{ "<num>", "Focus specified window number." },
{ "<barejid>", "Focus chat window with contact by JID if open." },
{ "<nick>", "Focus chat window with contact by nickname if open." },
{ "<roomjid>", "Focus chat room window with roomjid if open." },
{ "<roomoccupantjid>", "Focus private chat roomoccupantjid if open." },
{ "xmlconsole", "Focus the XML Console window if open." },
{ "<plugin>", "Focus the plugin window." })
CMD_EXAMPLES(
"/win console",
"/win 4",
"/win odin@valhalla.edda",
"/win Eddie",
"/win bigroom@conference.chat.org",
"/win bigroom@conference.chat.org/thor",
"/win wikipedia")
},
{ "/wins",
parse_args, 0, 3, NULL,
CMD_SUBFUNCS(
{ "unread", cmd_wins_unread },
{ "prune", cmd_wins_prune },
{ "swap", cmd_wins_swap })
CMD_MAINFUNC(cmd_wins)
CMD_TAGS(
CMD_TAG_UI)
CMD_SYN(
"/wins",
"/wins unread",
"/wins prune",
"/wins swap <source> <target>")
CMD_DESC(
"Manage windows. "
"Passing no argument will list all currently active windows and information about their usage.")
CMD_ARGS(
{ "unread", "List windows with unread messages." },
{ "prune", "Close all windows with no unread messages." },
{ "swap <source> <target>", "Swap windows, target may be an empty position." })
CMD_NOEXAMPLES
},
{ "/sub",
parse_args, 1, 2, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_sub)
CMD_TAGS(
CMD_TAG_ROSTER)
CMD_SYN(
"/sub request [<jid>]",
"/sub allow [<jid>]",
"/sub deny [<jid>]",
"/sub show [<jid>]",
"/sub sent",
"/sub received")
CMD_DESC(
"Manage subscriptions to contact presence. "
"If jid is omitted, the contact of the current window is used.")
CMD_ARGS(
{ "request [<jid>]", "Send a subscription request to the user." },
{ "allow [<jid>]", "Approve a contact's subscription request." },
{ "deny [<jid>]", "Remove subscription for a contact, or deny a request." },
{ "show [<jid>]", "Show subscription status for a contact." },
{ "sent", "Show all sent subscription requests pending a response." },
{ "received", "Show all received subscription requests awaiting your response." })
CMD_EXAMPLES(
"/sub request odin@valhalla.edda",
"/sub allow odin@valhalla.edda",
"/sub request",
"/sub sent")
},
{ "/who",
parse_args, 0, 2, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_who)
CMD_TAGS(
CMD_TAG_CHAT,
CMD_TAG_GROUPCHAT,
CMD_TAG_ROSTER)
CMD_SYN(
"/who",
"/who online|offline|away|dnd|xa|chat|available|unavailable|any [<group>]",
"/who moderator|participant|visitor",
"/who owner|admin|member")
CMD_DESC(
"Show contacts or room occupants with chosen status, role or affiliation.")
CMD_ARGS(
{ "offline|away|dnd|xa|chat", "Show contacts or room occupants with specified presence." },
{ "online", "Contacts that are online, chat, away, xa, dnd." },
{ "available", "Contacts that are available for chat - online, chat." },
{ "unavailable", "Contacts that are not available for chat - offline, away, xa, dnd." },
{ "any", "Contacts with any status (same as calling with no argument)." },
{ "<group>", "Filter the results by the specified roster group, not applicable in chat rooms." },
{ "moderator|participant|visitor", "Room occupants with the specified role." },
{ "owner|admin|member", "Room occupants with the specified affiliation." })
CMD_EXAMPLES(
"/who",
"/who xa",
"/who online friends",
"/who any family",
"/who participant",
"/who admin")
},
{ "/close",
parse_args, 0, 1, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_close)
CMD_TAGS(
CMD_TAG_UI)
CMD_SYN(
"/close",
"/close <num>",
"/close <barejid>",
"/close <nick>",
"/close <roomjid>",
"/close <roomoccupantjid>",
"/close xmlconsole",
"/close all|read")
CMD_DESC(
"Close windows. "
"Passing no argument closes the current window.")
CMD_ARGS(
{ "<num>", "Close specified window number." },
{ "<barejid>", "Close chat window with contact by JID if open." },
{ "<nick>", "Close chat window with contact by nickname if open." },
{ "<roomjid>", "Close chat room window with roomjid if open." },
{ "<roomoccupantjid>", "Close private chat roomoccupantjid if open." },
{ "xmlconsole", "Close the XML Console window if open." },
{ "all", "Close all windows." },
{ "read", "Close all windows that have no unread messages." })
CMD_NOEXAMPLES
},
{ "/clear",
parse_args, 0, 2, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_clear)
CMD_TAGS(
CMD_TAG_UI)
CMD_SYN(
"/clear",
"/clear persist_history <on|off>")
CMD_DESC(
"Clear the current window. "
"If you set persist_history you can still access the history by pressing PAGE UP.")
CMD_ARGS(
{ "persist_history on|off", "Whether or not to clear the screen persistently." })
CMD_EXAMPLES(
"/clear",
"/clear persist_history",
"/clear persist_history on")
},
{ "/quit",
parse_args, 0, 0, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_quit)
CMD_NOTAGS
CMD_SYN(
"/quit")
CMD_DESC(
"Logout of any current session, and quit Profanity.")
CMD_NOARGS
CMD_NOEXAMPLES
},
{ "/privileges",
parse_args, 1, 1, &cons_privileges_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_privileges)
CMD_TAGS(
CMD_TAG_GROUPCHAT,
CMD_TAG_UI)
CMD_SYN(
"/privileges on|off")
CMD_DESC(
"Group occupants panel by role, and show role information in chat rooms.")
CMD_ARGS(
{ "on|off", "Enable or disable privilege information." })
CMD_NOEXAMPLES
},
{ "/charset",
parse_args, 0, 0, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_charset)
CMD_TAGS(
CMD_TAG_UI)
CMD_SYN(
"/charset")
CMD_DESC(
"Display information about the current character set supported by the terminal. ")
CMD_NOARGS
CMD_NOEXAMPLES
},
{ "/beep",
parse_args, 1, 1, &cons_beep_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_beep)
CMD_TAGS(
CMD_TAG_UI)
CMD_SYN(
"/beep on|off")
CMD_DESC(
"Switch the terminal bell on or off. "
"The bell will sound when incoming messages are received. "
"If the terminal does not support sounds, it may attempt to flash the screen instead.")
CMD_ARGS(
{ "on|off", "Enable or disable terminal bell." })
CMD_NOEXAMPLES
},
{ "/console",
parse_args, 2, 2, &cons_console_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_console)
CMD_TAGS(
CMD_TAG_UI,
CMD_TAG_CHAT,
CMD_TAG_GROUPCHAT)
CMD_SYN(
"/console chat all|first|none",
"/console muc all|first|mention|none",
"/console private all|first|none")
CMD_DESC(
"Configure what is displayed in the console window when messages are received. "
"The default is set to 'all' for all types of messages.")
CMD_ARGS(
{ "chat all", "Indicate all new chat messages in the console." },
{ "chat first", "Indicate only the first new message per chat in the console." },
{ "chat none", "Do not show any new chat messages in the console window." },
{ "muc all", "Indicate all new chat room messages in the console." },
{ "muc first", "Indicate only the first new message in each room in the console." },
{ "muc mention", "Indicate only messages in which you have beeen mentioned in the console." },
{ "muc none", "Do not show any new chat room messages in the console window." },
{ "private all", "Indicate all new private room messages in the console." },
{ "private first", "Indicate only the first private room message in the console." },
{ "private none", "Do not show any new private room messages in the console window." })
CMD_NOEXAMPLES
},
{ "/presence",
parse_args, 2, 2, &cons_presence_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_presence)
CMD_TAGS(
CMD_TAG_UI,
CMD_TAG_CHAT,
CMD_TAG_GROUPCHAT)
CMD_SYN(
"/presence titlebar on|off",
"/presence console all|online|none",
"/presence chat all|online|none",
"/presence room all|online|none")
CMD_DESC(
"Show the contacts presence in the titlebar and configure presence messages in different window types.")
CMD_ARGS(
{ "titlebar on|off", "Switch display of the contacts presence in the titlebar on or off." },
{ "console all", "Show all presence changes in the console window." },
{ "console online", "Show only online/offline presence changes in the console window." },
{ "console none", "Don't show any presence changes in the console window." },
{ "chat all", "Show all presence changes in the chat windows." },
{ "chat online", "Show only online/offline presence changes in chat windows." },
{ "chat none", "Don't show any presence changes in chat windows." },
{ "room all", "Show all presence changes in chat room windows." },
{ "room online", "Show only online/offline presence changes in chat room windows." },
{ "room none", "Don't show any presence changes in chat room windows." })
CMD_EXAMPLES(
"/presence titlebar off",
"/presence console none",
"/presence chat online",
"/presence room all")
},
{ "/wrap",
parse_args, 1, 1, &cons_wrap_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_wrap)
CMD_TAGS(
CMD_TAG_UI)
CMD_SYN(
"/wrap on|off")
CMD_DESC(
"Word wrapping.")
CMD_ARGS(
{ "on|off", "Enable or disable word wrapping in the main window." })
CMD_NOEXAMPLES
},
{ "/time",
parse_args, 1, 3, &cons_time_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_time)
CMD_TAGS(
CMD_TAG_UI)
CMD_SYN(
"/time all|console|chat|muc|config|private|xml set <format>",
"/time all|console|chat|muc|config|private|xml off",
"/time statusbar set <format>",
"/time statusbar off",
"/time lastactivity set <format>")
CMD_DESC(
"Configure time display preferences. "
"Time formats are strings supported by g_date_time_format. "
"See https://developer.gnome.org/glib/stable/glib-GDateTime.html#g-date-time-format for more details. "
"Setting the format to an unsupported string, will display the string. "
"If the format contains spaces, it must be surrounded with double quotes.")
CMD_ARGS(
{ "console set <format>", "Set time format for console window." },
{ "console off", "Do not show time in console window." },
{ "chat set <format>", "Set time format for chat windows." },
{ "chat off", "Do not show time in chat windows." },
{ "muc set <format>", "Set time format for chat room windows." },
{ "muc off", "Do not show time in chat room windows." },
{ "config set <format>", "Set time format for config windows." },
{ "config off", "Do not show time in config windows." },
{ "private set <format>", "Set time format for private chat windows." },
{ "private off", "Do not show time in private chat windows." },
{ "xml set <format>", "Set time format for XML console window." },
{ "xml off", "Do not show time in XML console window." },
{ "statusbar set <format>", "Change time format in statusbar." },
{ "statusbar off", "Do not show time in status bar." },
{ "lastactivity set <format>", "Change time format for last activity." },
{ "all set <format>", "Set time for: console, chat, muc, config, private and xml windows." },
{ "all off", "Do not show time for: console, chat, muc, config, private and xml windows." })
CMD_EXAMPLES(
"/time console set %H:%M:%S",
"/time chat set \"%d-%m-%y %H:%M:%S\"",
"/time xml off",
"/time statusbar set %H:%M",
"/time lastactivity set \"%d-%m-%y %H:%M:%S\"",
"/time all set \"%d-%m-%y %H:%M:%S\"")
},
{ "/inpblock",
parse_args, 2, 2, &cons_inpblock_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_inpblock)
CMD_TAGS(
CMD_TAG_UI)
CMD_SYN(
"/inpblock timeout <millis>",
"/inpblock dynamic on|off")
CMD_DESC(
"How long to wait for keyboard input before checking for new messages or checking for state changes such as 'idle'.")
CMD_ARGS(
{ "timeout <millis>", "Time to wait (1-1000) in milliseconds before reading input from the terminal buffer, default: 1000." },
{ "dynamic on|off", "Start with 0 millis and dynamically increase up to timeout when no activity, default: on." })
CMD_NOEXAMPLES },
{ "/titlebar",
parse_args, 1, 2, &cons_titlebar_setting,
CMD_SUBFUNCS(
{ "show", cmd_titlebar_show_hide },
{ "hide", cmd_titlebar_show_hide })
CMD_MAINFUNC(cmd_titlebar)
CMD_TAGS(
CMD_TAG_UI)
CMD_SYN(
"/titlebar up",
"/titlebar down",
"/titlebar show|hide [encwarn|resource|tls]")
CMD_DESC(
"Titlebar settings.")
CMD_ARGS(
{ "up", "Move the title bar up the screen." },
{ "down", "Move the title bar down the screen." },
{ "show tls", "Show or hide TLS indicator in the titlebar." },
{ "show encwarn", "Enable or disable the unencrypted warning message in the titlebar." },
{ "show resource", "Show or hide the current resource in the titlebar." },
{ "show name", "In case of a MUC. Show the MUC name in the titlebar." },
{ "show jid", "In case of a MUC. Show the JID in the titlebar." })
CMD_EXAMPLES(
"/titlebar up",
"/titlebar show tls",
"/titlebar hide encwarn")
},
{ "/mainwin",
parse_args, 1, 1, &cons_winpos_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_mainwin)
CMD_TAGS(
CMD_TAG_UI)
CMD_SYN(
"/mainwin up",
"/mainwin down")
CMD_DESC(
"Move the main window.")
CMD_ARGS(
{ "up", "Move the main window up the screen." },
{ "down", "Move the main window down the screen." })
CMD_NOEXAMPLES
},
{ "/statusbar",
parse_args, 1, 2, &cons_statusbar_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_statusbar)
CMD_TAGS(
CMD_TAG_UI)
CMD_SYN(
"/statusbar show name|number|read",
"/statusbar hide name|number|read",
"/statusbar maxtabs <value>",
"/statusbar tablen <value>",
"/statusbar self user|barejid|fulljid|off",
"/statusbar chat user|jid",
"/statusbar room room|jid",
"/statusbar up",
"/statusbar down")
CMD_DESC(
"Manage statusbar display preferences.")
CMD_ARGS(
{ "maxtabs <value>", "Set the maximum number of tabs to display, <value> must be between 0 and 10." },
{ "tablen <value>", "Set the maximum number of characters to show as the tab name, 0 sets to unlimited." },
{ "show|hide name", "Show or hide names in tabs." },
{ "show|hide number", "Show or hide numbers in tabs." },
{ "show|hide read", "Show or hide inactive tabs." },
{ "self user|barejid|fulljid", "Show account user name, barejid, fulljid as status bar title." },
{ "self off", "Disable showing self as status bar title." },
{ "chat user|jid", "Show users name, or the fulljid if no nick is present for chat tabs." },
{ "room room|jid", "Show room name, or the fulljid for room tabs." },
{ "up", "Move the status bar up the screen." },
{ "down", "Move the status bar down the screen." })
CMD_EXAMPLES(
"/statusbar maxtabs 8",
"/statusbar tablen 5",
"/statusbar self user",
"/statusbar chat jid",
"/statusbar hide read",
"/statusbar hide name")
},
{ "/inputwin",
parse_args, 1, 1, &cons_winpos_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_inputwin)
CMD_TAGS(
CMD_TAG_UI)
CMD_SYN(
"/inputwin up",
"/inputwin down")
CMD_DESC(
"Move the input window.")
CMD_ARGS(
{ "up", "Move the input window up the screen." },
{ "down", "Move the input window down the screen." })
CMD_NOEXAMPLES
},
{ "/notify",
parse_args_with_freetext, 0, 4, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_notify)
CMD_TAGS(
CMD_TAG_UI,
CMD_TAG_CHAT,
CMD_TAG_GROUPCHAT)
CMD_SYN(
"/notify chat on|off",
"/notify chat current on|off",
"/notify chat text on|off",
"/notify room on|off",
"/notify room mention on|off",
"/notify room mention case_sensitive|case_insensitive",
"/notify room mention word_whole|word_part",
"/notify room current on|off",
"/notify room text on|off",
"/notify room trigger add <text>",
"/notify room trigger remove <text>",
"/notify room trigger list",
"/notify room trigger on|off",
"/notify on|off",
"/notify mention on|off",
"/notify trigger on|off",
"/notify reset",
"/notify remind <seconds>",
"/notify typing on|off",
"/notify typing current on|off",
"/notify invite on|off",
"/notify sub on|off")
CMD_DESC(
"Configure desktop notifications. "
"To configure presence update messages in the console, chat and chat room windows, see '/help presence'.")
CMD_ARGS(
{ "chat on|off", "Notifications for regular chat messages." },
{ "chat current on|off", "Whether to show regular chat message notifications when the window is focused." },
{ "chat text on|off", "Show message text in regular message notifications." },
{ "room on|off", "Notifications for all chat room messages." },
{ "room mention on|off", "Notifications for chat room messages when your nick is mentioned." },
{ "room mention case_sensitive", "Set room mention notifications as case sensitive." },
{ "room mention case_insensitive", "Set room mention notifications as case insensitive." },
{ "room mention word_whole", "Set room mention notifications only on whole word match, i.e. when nickname is not part of a larger word." },
{ "room mention word_part", "Set room mention notifications on partial word match, i.e. nickname may be part of a larger word." },
{ "room current on|off", "Whether to show all chat room messages notifications when the window is focused." },
{ "room text on|off", "Show message text in chat room message notifications." },
{ "room trigger add <text>", "Notify when specified text included in all chat room messages." },
{ "room trigger remove <text>", "Remove chat room notification trigger." },
{ "room trigger list", "List all chat room highlight triggers." },
{ "room trigger on|off", "Enable or disable all chat room notification triggers." },
{ "on|off", "Override the global message setting for the current chat room." },
{ "mention on|off", "Override the global 'mention' setting for the current chat room." },
{ "trigger on|off", "Override the global 'trigger' setting for the current chat room." },
{ "reset", "Reset to global notification settings for the current chat room." },
{ "remind <seconds>", "Notification reminder period for unread messages, use 0 to disable." },
{ "typing on|off", "Notifications when contacts are typing." },
{ "typing current on|off", "Whether typing notifications are triggered for the current window." },
{ "invite on|off", "Notifications for chat room invites." },
{ "sub on|off", "Notifications for subscription requests." })
CMD_EXAMPLES(
"/notify chat on",
"/notify chat text on",
"/notify room mention on",
"/notify room trigger add beer",
"/notify room trigger on",
"/notify room current off",
"/notify room text off",
"/notify remind 60",
"/notify typing on",
"/notify invite on")
},
{ "/flash",
parse_args, 1, 1, &cons_flash_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_flash)
CMD_TAGS(
CMD_TAG_UI)
CMD_SYN(
"/flash on|off")
CMD_DESC(
"Make the terminal flash when incoming messages are received in another window. "
"If the terminal doesn't support flashing, it may attempt to beep.")
CMD_ARGS(
{ "on|off", "Enable or disable terminal flash." })
CMD_NOEXAMPLES
},
{ "/tray",
parse_args, 1, 2, &cons_tray_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_tray)
CMD_TAGS(
CMD_TAG_UI)
CMD_SYN(
"/tray on|off",
"/tray read on|off",
"/tray timer <seconds>")
CMD_DESC(
"Display an icon in the tray that will indicate new messages.")
CMD_ARGS(
{ "on|off", "Show tray icon." },
{ "read on|off", "Show tray icon when no unread messages." },
{ "timer <seconds>", "Set tray icon timer, seconds must be between 1-10." })
CMD_NOEXAMPLES
},
{ "/intype",
parse_args, 1, 1, &cons_intype_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_intype)
CMD_TAGS(
CMD_TAG_UI,
CMD_TAG_CHAT)
CMD_SYN(
"/intype on|off")
CMD_DESC(
"Show when a contact is typing in the console, and in active message window.")
CMD_ARGS(
{ "on|off", "Enable or disable contact typing messages." })
CMD_NOEXAMPLES
},
{ "/splash",
parse_args, 1, 1, &cons_splash_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_splash)
CMD_TAGS(
CMD_TAG_UI)
CMD_SYN(
"/splash on|off")
CMD_DESC(
"Switch on or off the ascii logo on start up and when the /about command is called.")
CMD_ARGS(
{ "on|off", "Enable or disable splash logo." })
CMD_NOEXAMPLES
},
{ "/autoconnect",
parse_args, 1, 2, &cons_autoconnect_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_autoconnect)
CMD_TAGS(
CMD_TAG_CONNECTION)
CMD_SYN(
"/autoconnect set <account>",
"/autoconnect off")
CMD_DESC(
"Enable or disable autoconnect on start up. "
"The setting can be overridden by the -a (--account) command line option.")
CMD_ARGS(
{ "set <account>", "Connect with account on start up." },
{ "off", "Disable autoconnect." })
CMD_EXAMPLES(
"/autoconnect set ulfhednar@valhalla.edda",
"/autoconnect off")
},
{ "/vercheck",
parse_args, 0, 1, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_vercheck)
CMD_TAGS(
CMD_TAG_UI)
CMD_SYN(
"/vercheck on|off")
CMD_DESC(
"Check for new versions when Profanity starts, and when the /about command is run.")
CMD_ARGS(
{ "on|off", "Enable or disable the version check." })
CMD_NOEXAMPLES
},
{ "/wintitle",
parse_args, 2, 2, &cons_wintitle_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_wintitle)
CMD_TAGS(
CMD_TAG_UI)
CMD_SYN(
"/wintitle show on|off",
"/wintitle goodbye on|off")
CMD_DESC(
"Allow Profanity to modify the window title bar.")
CMD_ARGS(
{ "show on|off", "Show current logged in user, and unread messages as the window title." },
{ "goodbye on|off", "Show a message in the title when exiting profanity." })
CMD_NOEXAMPLES
},
{ "/alias",
parse_args_with_freetext, 1, 3, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_alias)
CMD_NOTAGS
CMD_SYN(
"/alias list",
"/alias add <name> <value>",
"/alias remove <name>")
CMD_DESC(
"Add, remove or list command aliases.")
CMD_ARGS(
{ "list", "List all aliases." },
{ "add <name> <value>", "Add a new command alias." },
{ "remove <name>", "Remove a command alias." })
CMD_EXAMPLES(
"/alias add friends /who online friends",
"/alias add /q /quit",
"/alias add a /away \"I'm in a meeting.\"",
"/alias remove q",
"/alias list")
},
{ "/logging",
parse_args, 2, 3, &cons_logging_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_logging)
CMD_TAGS(
CMD_TAG_CHAT)
CMD_SYN(
"/logging chat|group on|off")
CMD_DESC(
"Configure chat logging. "
"Switch logging on or off. "
"Chat logging will be enabled if /history is set to on. "
"When disabling this option, /history will also be disabled. ")
CMD_ARGS(
{ "chat on|off", "Enable/Disable regular chat logging." },
{ "group on|off", "Enable/Disable groupchat (room) logging." })
CMD_EXAMPLES(
"/logging chat on",
"/logging group off")
},
{ "/states",
parse_args, 1, 1, &cons_states_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_states)
CMD_TAGS(
CMD_TAG_CHAT)
CMD_SYN(
"/states on|off")
CMD_DESC(
"Send chat state notifications to recipient during chat sessions, such as typing, paused, active, gone.")
CMD_ARGS(
{ "on|off", "Enable or disable sending of chat state notifications." })
CMD_NOEXAMPLES },
{ "/pgp",
parse_args, 1, 3, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_pgp)
CMD_TAGS(
CMD_TAG_CHAT,
CMD_TAG_UI)
CMD_SYN(
"/pgp libver",
"/pgp keys",
"/pgp contacts",
"/pgp setkey <contact> <keyid>",
"/pgp start [<contact>]",
"/pgp end",
"/pgp log on|off|redact",
"/pgp char <char>",
"/pgp sendfile on|off")
CMD_DESC(
"Open PGP commands to manage keys, and perform PGP encryption during chat sessions. "
"See the /account command to set your own PGP key.")
CMD_ARGS(
{ "libver", "Show which version of the libgpgme library is being used." },
{ "keys", "List all keys known to the system." },
{ "contacts", "Show contacts with assigned public keys." },
{ "setkey <contact> <keyid>", "Manually associate a contact with a public key." },
{ "start [<contact>]", "Start PGP encrypted chat, current contact will be used if not specified." },
{ "end", "End PGP encrypted chat with the current recipient." },
{ "log on|off", "Enable or disable plaintext logging of PGP encrypted messages." },
{ "log redact", "Log PGP encrypted messages, but replace the contents with [redacted]. This is the default." },
{ "char <char>", "Set the character to be displayed next to PGP encrypted messages." },
{ "sendfile on|off", "Allow /sendfile to send unencrypted files while otherwise using PGP." })
CMD_EXAMPLES(
"/pgp log off",
"/pgp setkey odin@valhalla.edda BA19CACE5A9592C5",
"/pgp start odin@valhalla.edda",
"/pgp end",
"/pgp char P")
},
// XEP-0373: OpenPGP for XMPP
#ifdef HAVE_LIBGPGME
{ "/ox",
parse_args, 1, 3, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_ox)
CMD_TAGS(
CMD_TAG_CHAT,
CMD_TAG_UI)
CMD_SYN(
"/ox keys",
"/ox contacts",
"/ox start [<contact>]",
"/ox end",
"/ox log on|off|redact",
"/ox char <char>",
"/ox sendfile on|off",
"/ox announce <file>",
"/ox discover",
"/ox request <jid>")
CMD_DESC(
"OpenPGP (OX) commands to manage keys, and perform PGP encryption during chat sessions. ")
CMD_ARGS(
{ "keys", "List all keys known to the system." },
{ "contacts", "Show contacts with assigned public keys." },
{ "start [<contact>]", "Start PGP encrypted chat, current contact will be used if not specified." },
{ "end", "End PGP encrypted chat with the current recipient." },
{ "log on|off", "Enable or disable plaintext logging of PGP encrypted messages." },
{ "log redact", "Log PGP encrypted messages, but replace the contents with [redacted]. This is the default." },
{ "char <char>", "Set the character to be displayed next to PGP encrypted messages." },
{ "announce <file>", "Announce a public key by pushing it on the XMPP Server" },
{ "discover <jid>", "Discover public keys of a jid " },
{ "request <jid>", "Request public keys" },
{ "sendfile on|off", "Allow /sendfile to send unencrypted files while otherwise using PGP." })
CMD_EXAMPLES(
"/ox log off",
"/ox start odin@valhalla.edda",
"/ox end",
"/ox char X")
},
#endif // HAVE_LIBGPGME
{ "/otr",
parse_args, 1, 3, NULL,
CMD_SUBFUNCS(
{ "char", cmd_otr_char },
{ "log", cmd_otr_log },
{ "libver", cmd_otr_libver },
{ "policy", cmd_otr_policy },
{ "gen", cmd_otr_gen },
{ "myfp", cmd_otr_myfp },
{ "theirfp", cmd_otr_theirfp },
{ "start", cmd_otr_start },
{ "end", cmd_otr_end },
{ "trust", cmd_otr_trust },
{ "untrust", cmd_otr_untrust },
{ "secret", cmd_otr_secret },
{ "question", cmd_otr_question },
{ "answer", cmd_otr_answer },
{ "sendfile", cmd_otr_sendfile })
CMD_NOMAINFUNC
CMD_TAGS(
CMD_TAG_CHAT,
CMD_TAG_UI)
CMD_SYN(
"/otr libver",
"/otr gen",
"/otr myfp|theirfp",
"/otr start [<contact>]",
"/otr end",
"/otr trust|untrust",
"/otr secret <secret>",
"/otr question <question> <answer>",
"/otr answer <answer>",
"/otr policy manual|opportunistic|always [<contact>]",
"/otr log on|off|redact",
"/otr char <char>",
"/otr sendfile on|off")
CMD_DESC(
"Off The Record (OTR) commands to manage keys, and perform OTR encryption during chat sessions.")
CMD_ARGS(
{ "libver", "Show which version of the libotr library is being used." },
{ "gen", "Generate your private key." },
{ "myfp", "Show your fingerprint." },
{ "theirfp", "Show contacts fingerprint." },
{ "start [<contact>]", "Start an OTR session with contact, or current recipient if omitted." },
{ "end", "End the current OTR session." },
{ "trust|untrust", "Indicate whether or not you trust the contact's fingerprint." },
{ "secret <secret>", "Verify a contact's identity using a shared secret." },
{ "question <question> <answer>", "Verify a contact's identity using a question and expected answer." },
{ "answer <answer>", "Respond to a question answer verification request with your answer." },
{ "policy manual", "Set the global OTR policy to manual, OTR sessions must be started manually." },
{ "policy manual <contact>", "Set the OTR policy to manual for a specific contact." },
{ "policy opportunistic", "Set the global OTR policy to opportunistic, an OTR session will be attempted upon starting a conversation." },
{ "policy opportunistic <contact>", "Set the OTR policy to opportunistic for a specific contact." },
{ "policy always", "Set the global OTR policy to always, an error will be displayed if an OTR session cannot be initiated upon starting a conversation." },
{ "policy always <contact>", "Set the OTR policy to always for a specific contact." },
{ "log on|off", "Enable or disable plaintext logging of OTR encrypted messages." },
{ "log redact", "Log OTR encrypted messages, but replace the contents with [redacted]. This is the default." },
{ "char <char>", "Set the character to be displayed next to OTR encrypted messages." },
{ "sendfile on|off", "Allow /sendfile to send unencrypted files while in an OTR session." })
CMD_EXAMPLES(
"/otr log off",
"/otr policy manual",
"/otr policy opportunistic odin@valhalla.edda",
"/otr gen",
"/otr start odin@valhalla.edda",
"/otr myfp",
"/otr theirfp",
"/otr question \"What is the name of my rabbit?\" fiffi",
"/otr end",
"/otr char *")
},
{ "/outtype",
parse_args, 1, 1, &cons_outtype_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_outtype)
CMD_TAGS(
CMD_TAG_CHAT)
CMD_SYN(
"/outtype on|off")
CMD_DESC(
"Send typing notifications, chat states (/states) will be enabled if this setting is enabled.")
CMD_ARGS(
{ "on|off", "Enable or disable sending typing notifications." })
CMD_NOEXAMPLES
},
{ "/gone",
parse_args, 1, 1, &cons_gone_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_gone)
CMD_TAGS(
CMD_TAG_CHAT)
CMD_SYN(
"/gone <minutes>")
CMD_DESC(
"Send a 'gone' state to the recipient after the specified number of minutes. "
"Chat states (/states) will be enabled if this setting is set.")
CMD_ARGS(
{ "<minutes>", "Number of minutes of inactivity before sending the 'gone' state, a value of 0 will disable sending this state." })
CMD_NOEXAMPLES
},
{ "/history",
parse_args, 1, 1, &cons_history_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_history)
CMD_TAGS(
CMD_TAG_UI,
CMD_TAG_CHAT)
CMD_SYN(
"/history on|off")
CMD_DESC(
"Switch chat history on or off, /logging chat will automatically be enabled when this setting is on. "
"When history is enabled, previous messages are shown in chat windows.")
CMD_ARGS(
{ "on|off", "Enable or disable showing chat history." })
CMD_NOEXAMPLES
},
{ "/log",
parse_args, 1, 2, &cons_log_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_log)
CMD_NOTAGS
CMD_SYN(
"/log where",
"/log rotate on|off",
"/log maxsize <bytes>",
"/log shared on|off")
CMD_DESC(
"Manage profanity log settings.")
CMD_ARGS(
{ "where", "Show the current log file location." },
{ "rotate on|off", "Rotate log, default on. Does not take effect if you specified a filename yourself when starting Profanity." },
{ "maxsize <bytes>", "With rotate enabled, specifies the max log size, defaults to 1048580 (1MB)." },
{ "shared on|off", "Share logs between all instances, default: on. When off, the process id will be included in the log filename. Does not take effect if you specified a filename yourself when starting Profanity." })
CMD_NOEXAMPLES
},
{ "/carbons",
parse_args, 1, 1, &cons_carbons_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_carbons)
CMD_TAGS(
CMD_TAG_CHAT)
CMD_SYN(
"/carbons on|off")
CMD_DESC(
"Enable or disable message carbons. "
"Message carbons ensure that both sides of all conversations are shared with all the user's clients that implement this protocol.")
CMD_ARGS(
{ "on|off", "Enable or disable message carbons." })
CMD_NOEXAMPLES
},
{ "/receipts",
parse_args, 2, 2, &cons_receipts_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_receipts)
CMD_TAGS(
CMD_TAG_CHAT)
CMD_SYN(
"/receipts request on|off",
"/receipts send on|off")
CMD_DESC(
"Enable or disable message delivery receipts. The interface will indicate when a message has been received.")
CMD_ARGS(
{ "request on|off", "Whether or not to request a receipt upon sending a message." },
{ "send on|off", "Whether or not to send a receipt if one has been requested with a received message." })
CMD_NOEXAMPLES
},
{ "/reconnect",
parse_args, 1, 1, &cons_reconnect_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_reconnect)
CMD_TAGS(
CMD_TAG_CONNECTION)
CMD_SYN(
"/reconnect <seconds>")
CMD_DESC(
"Set the reconnect attempt interval for when the connection is lost.")
CMD_ARGS(
{ "<seconds>", "Number of seconds before attempting to reconnect, a value of 0 disables reconnect." })
CMD_NOEXAMPLES
},
{ "/autoping",
parse_args, 2, 2, &cons_autoping_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_autoping)
CMD_TAGS(
CMD_TAG_CONNECTION)
CMD_SYN(
"/autoping set <seconds>",
"/autoping timeout <seconds>")
CMD_DESC(
"Set the interval between sending ping requests to the server to ensure the connection is kept alive.")
CMD_ARGS(
{ "set <seconds>", "Number of seconds between sending pings, a value of 0 disables autoping." },
{ "timeout <seconds>", "Seconds to wait for autoping responses, after which the connection is considered broken." })
CMD_NOEXAMPLES
},
{ "/ping",
parse_args, 0, 1, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_ping)
CMD_TAGS(
CMD_TAG_CONNECTION)
CMD_SYN(
"/ping [<jid>]")
CMD_DESC(
"Sends an IQ ping stanza to the specified JID. "
"If no JID is supplied, your chat server will be pinged.")
CMD_ARGS(
{ "<jid>", "The Jabber ID to send the ping request to." })
CMD_NOEXAMPLES
},
{ "/autoaway",
parse_args_with_freetext, 2, 3, &cons_autoaway_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_autoaway)
CMD_TAGS(
CMD_TAG_PRESENCE)
CMD_SYN(
"/autoaway mode idle|away|off",
"/autoaway time away|xa <minutes>",
"/autoaway message away|xa <message>|off",
"/autoaway check on|off")
CMD_DESC(
"Manage autoaway settings for idle time.")
CMD_ARGS(
{ "mode idle", "Sends idle time, status remains online." },
{ "mode away", "Sends away and xa presence as well as idle time." },
{ "mode off", "Disabled (default)." },
{ "time away <minutes>", "Number of minutes before the away presence is sent, default: 15." },
{ "time xa <minutes>", "Number of minutes before the xa presence is sent, default: 0 (disabled)." },
{ "message away <message>", "Optional message to send with the away presence, default: off (disabled)." },
{ "message xa <message>", "Optional message to send with the xa presence, default: off (disabled)." },
{ "message away off", "Send no message with away presence." },
{ "message xa off", "Send no message with xa presence." },
{ "check on|off", "When enabled, checks for activity and sends online presence, default: on." })
CMD_EXAMPLES(
"/autoaway mode away",
"/autoaway time away 30",
"/autoaway message away Away from computer for a while",
"/autoaway time xa 120",
"/autoaway message xa Away from computer for a very long time",
"/autoaway check off")
},
{ "/priority",
parse_args, 1, 1, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_priority)
CMD_TAGS(
CMD_TAG_PRESENCE)
CMD_SYN(
"/priority <priority>")
CMD_DESC(
"Set priority for the current account. "
"See the /account command for specific priority settings per presence status.")
CMD_ARGS(
{ "<priority>", "Number between -128 and 127, default: 0." })
CMD_NOEXAMPLES
},
{ "/account",
parse_args, 0, 4, NULL,
CMD_SUBFUNCS(
{ "list", cmd_account_list },
{ "show", cmd_account_show },
{ "add", cmd_account_add },
{ "remove", cmd_account_remove },
{ "enable", cmd_account_enable },
{ "disable", cmd_account_disable },
{ "rename", cmd_account_rename },
{ "default", cmd_account_default },
{ "set", cmd_account_set },
{ "clear", cmd_account_clear })
CMD_MAINFUNC(cmd_account)
CMD_TAGS(
CMD_TAG_CONNECTION,
CMD_TAG_PRESENCE,
CMD_TAG_CHAT,
CMD_TAG_GROUPCHAT)
CMD_SYN(
"/account",
"/account list",
"/account show <account>",
"/account enable|disable <account>",
"/account default set <account>",
"/account default off",
"/account add <account>",
"/account remove <account>",
"/account rename <account> <newaccount>",
"/account set <account> jid <jid>",
"/account set <account> server <server>",
"/account set <account> port <port>",
"/account set <account> status <presence>",
"/account set <account> status last",
"/account set <account> <presence> <priority>",
"/account set <account> resource <resource>",
"/account set <account> password <password>",
"/account set <account> eval_password <command>",
"/account set <account> muc <service>",
"/account set <account> nick <nick>",
"/account set <account> otr <policy>",
"/account set <account> pgpkeyid <pgpkeyid>",
"/account set <account> startscript <script>",
"/account set <account> tls force|allow|trust|legacy|disable",
"/account set <account> auth default|legacy",
"/account set <account> theme <theme>",
"/account clear <account> password",
"/account clear <account> eval_password",
"/account clear <account> server",
"/account clear <account> port",
"/account clear <account> otr",
"/account clear <account> pgpkeyid",
"/account clear <account> startscript",
"/account clear <account> muc",
"/account clear <account> resource")
CMD_DESC(
"Commands for creating and managing accounts. "
"Calling with no arguments will display information for the current account.")
CMD_ARGS(
{ "list", "List all accounts." },
{ "enable <account>", "Enable the account, it will be used for autocompletion." },
{ "show <account>", "Show details for the specified account." },
{ "disable <account>", "Disable the account." },
{ "default set <account>", "Set the default account, used when no argument passed to the /connect command." },
{ "default off", "Clear the default account setting." },
{ "add <account>", "Create a new account." },
{ "remove <account>", "Remove an account." },
{ "rename <account> <newaccount>", "Rename 'account' to 'newaccount'." },
{ "set <account> jid <jid>", "Set the Jabber ID for the account, account name will be used if not set." },
{ "set <account> server <server>", "The chat server, if different to the domainpart of the JID." },
{ "set <account> port <port>", "The port used for connecting if not the default (5222, or 5223 for SSL)." },
{ "set <account> status <presence>", "The presence status to use on login." },
{ "set <account> status last", "Use your last status before logging out, when logging in." },
{ "set <account> <presence> <priority>", "Set the priority (-128..127) to use for the specified presence." },
{ "set <account> resource <resource>", "The resource to be used for this account, defaults to 'profanity'." },
{ "set <account> password <password>", "Password for the account, note this is currently stored in plaintext if set." },
{ "set <account> eval_password <command>", "Shell command evaluated to retrieve password for the account. Can be used to retrieve password from keyring." },
{ "set <account> muc <service>", "The default MUC chat service to use, defaults to the servers disco info response." },
{ "set <account> nick <nick>", "The default nickname to use when joining chat rooms." },
{ "set <account> otr <policy>", "Override global OTR policy for this account, see /otr." },
{ "set <account> pgpkeyid <pgpkeyid>", "Set the ID of the PGP key for this account, see /pgp." },
{ "set <account> startscript <script>", "Set the script to execute after connecting." },
{ "set <account> tls force", "Force TLS connection, and fail if one cannot be established, this is default behaviour." },
{ "set <account> tls allow", "Use TLS for the connection if it is available." },
{ "set <account> tls trust", "Force TLS connection and trust server's certificate." },
{ "set <account> tls legacy", "Use legacy TLS for the connection. It means server doesn't support STARTTLS and TLS is forced just after TCP connection is established." },
{ "set <account> tls disable", "Disable TLS for the connection." },
{ "set <account> auth default", "Use default authentication process." },
{ "set <account> auth legacy", "Allow legacy authentication." },
{ "set <account> <theme>", "Set the UI theme for the account." },
{ "clear <account> server", "Remove the server setting for this account." },
{ "clear <account> port", "Remove the port setting for this account." },
{ "clear <account> password", "Remove the password setting for this account." },
{ "clear <account> eval_password", "Remove the eval_password setting for this account." },
{ "clear <account> otr", "Remove the OTR policy setting for this account." },
{ "clear <account> pgpkeyid", "Remove pgpkeyid associated with this account." },
{ "clear <account> startscript", "Remove startscript associated with this account." },
{ "clear <account> theme", "Clear the theme setting for the account, the global theme will be used." },
{ "clear <account> resource", "Remove the resource setting for this account." },
{ "clear <account> muc", "Remove the default MUC service setting." })
CMD_EXAMPLES(
"/account add me",
"/account set me jid ulfhednar@valhalla.edda",
"/account set me server talk.chat.com",
"/account set me port 5111",
"/account set me muc chatservice.mycompany.com",
"/account set me nick dennis",
"/account set me status dnd",
"/account set me dnd -1",
"/account rename me chattyme",
"/account clear me pgpkeyid")
},
{ "/plugins",
parse_args, 0, 3, NULL,
CMD_SUBFUNCS(
{ "sourcepath", cmd_plugins_sourcepath },
{ "install", cmd_plugins_install },
{ "uninstall", cmd_plugins_uninstall },
{ "update", cmd_plugins_update },
{ "load", cmd_plugins_load },
{ "unload", cmd_plugins_unload },
{ "reload", cmd_plugins_reload },
{ "python_version", cmd_plugins_python_version })
CMD_MAINFUNC(cmd_plugins)
CMD_NOTAGS
CMD_SYN(
"/plugins",
"/plugins sourcepath set <path>",
"/plugins sourcepath clear",
"/plugins install [<path>]",
"/plugins uninstall [<plugin>]",
"/plugins update [<path>]",
"/plugins unload [<plugin>]",
"/plugins load [<plugin>]",
"/plugins reload [<plugin>]",
"/plugins python_version")
CMD_DESC(
"Manage plugins. Passing no arguments lists currently loaded plugins.")
CMD_ARGS(
{ "sourcepath set <path>", "Set the default path to install plugins from, will be used if no arg is passed to /plugins install." },
{ "sourcepath clear", "Clear the default plugins source path." },
{ "install [<path>]", "Install a plugin, or all plugins found in a directory (recursive). Passing no argument will use the sourcepath if one is set." },
{ "uninstall [<plugin>]", "Uninstall a plugin." },
{ "update [<path>]", "Updates an installed plugin" },
{ "load [<plugin>]", "Load a plugin that already exists in the plugin directory, passing no argument loads all found plugins." },
{ "unload [<plugin>]", "Unload a loaded plugin, passing no argument will unload all plugins." },
{ "reload [<plugin>]", "Reload a plugin, passing no argument will reload all plugins." },
{ "python_version", "Show the Python interpreter version." })
CMD_EXAMPLES(
"/plugins sourcepath set /home/meee/projects/profanity-plugins",
"/plugins install",
"/plugins install /home/steveharris/Downloads/metal.py",
"/plugins update /home/steveharris/Downloads/metal.py",
"/plugins uninstall browser.py",
"/plugins load browser.py",
"/plugins unload say.py",
"/plugins reload wikipedia.py")
},
{ "/prefs",
parse_args, 0, 1, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_prefs)
CMD_NOTAGS
CMD_SYN(
"/prefs [ui|desktop|chat|log|conn|presence|otr|pgp|omemo]")
CMD_DESC(
"Show preferences for different areas of functionality. "
"Passing no arguments shows all preferences.")
CMD_ARGS(
{ "ui", "User interface preferences." },
{ "desktop", "Desktop notification preferences." },
{ "chat", "Chat state preferences." },
{ "log", "Logging preferences." },
{ "conn", "Connection handling preferences." },
{ "presence", "Chat presence preferences." },
{ "otr", "Off The Record preferences." },
{ "pgp", "OpenPGP preferences." },
{ "omemo", "OMEMO preferences." })
CMD_NOEXAMPLES
},
{ "/theme",
parse_args, 1, 2, &cons_theme_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_theme)
CMD_TAGS(
CMD_TAG_UI)
CMD_SYN(
"/theme list",
"/theme load <theme>",
"/theme full-load <theme>",
"/theme colours",
"/theme properties")
CMD_DESC(
"Load a theme, includes colours and UI options.")
CMD_ARGS(
{ "list", "List all available themes." },
{ "load <theme>", "Load colours from specified theme. 'default' will reset to the default theme." },
{ "full-load <theme>", "Same as 'load' but will also load preferences set in the theme, not just colours." },
{ "colours", "Show colour values as rendered by the terminal." },
{ "properties", "Show colour settings for current theme." })
CMD_EXAMPLES(
"/theme list",
"/theme load forest")
},
{ "/xmlconsole",
parse_args, 0, 0, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_xmlconsole)
CMD_TAGS(
CMD_TAG_UI)
CMD_SYN(
"/xmlconsole")
CMD_DESC(
"Open the XML console to view incoming and outgoing XMPP traffic.")
CMD_NOARGS
CMD_NOEXAMPLES
},
{ "/script",
parse_args, 1, 2, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_script)
CMD_NOTAGS
CMD_SYN(
"/script run <script>",
"/script list",
"/script show <script>")
CMD_DESC(
"Run command scripts. "
"Scripts are stored in $XDG_DATA_HOME/profanity/scripts/ which is usually $HOME/.local/share/profanity/scripts/.")
CMD_ARGS(
{ "script run <script>", "Execute a script." },
{ "script list", "List all scripts TODO." },
{ "script show <script>", "Show the commands in script TODO." })
CMD_EXAMPLES(
"/script list",
"/script run myscript",
"/script show somescript")
},
{ "/export",
parse_args, 1, 1, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_export)
CMD_NOTAGS
CMD_SYN(
"/export <filepath>")
CMD_DESC(
"Exports contacts to a csv file.")
CMD_ARGS(
{ "<filepath>", "Path to the output file." })
CMD_EXAMPLES(
"/export /path/to/output.csv",
"/export ~/contacts.csv")
},
{ "/cmd",
parse_args, 1, 3, NULL,
CMD_SUBFUNCS(
{ "list", cmd_command_list },
{ "exec", cmd_command_exec })
CMD_NOMAINFUNC
CMD_NOTAGS
CMD_SYN(
"/cmd list [<jid>]",
"/cmd exec <command> [<jid>]")
CMD_DESC(
"Execute ad hoc commands.")
CMD_ARGS(
{ "list", "List supported ad hoc commands." },
{ "exec <command>", "Execute a command." })
CMD_EXAMPLES(
"/cmd list",
"/cmd exec ping")
},
{ "/omemo",
parse_args, 1, 3, NULL,
CMD_SUBFUNCS(
{ "gen", cmd_omemo_gen },
{ "log", cmd_omemo_log },
{ "start", cmd_omemo_start },
{ "end", cmd_omemo_end },
{ "trustmode", cmd_omemo_trust_mode },
{ "trust", cmd_omemo_trust },
{ "untrust", cmd_omemo_untrust },
{ "fingerprint", cmd_omemo_fingerprint },
{ "char", cmd_omemo_char },
{ "policy", cmd_omemo_policy },
{ "clear_device_list", cmd_omemo_clear_device_list })
CMD_NOMAINFUNC
CMD_TAGS(
CMD_TAG_CHAT,
CMD_TAG_UI)
CMD_SYN(
"/omemo gen",
"/omemo log on|off|redact",
"/omemo start [<contact>]",
"/omemo trust [<contact>] <fingerprint>",
"/omemo end",
"/omemo fingerprint [<contact>]",
"/omemo char <char>",
"/omemo trustmode manual|firstusage|blind",
"/omemo policy manual|automatic|always",
"/omemo clear_device_list")
CMD_DESC(
"OMEMO commands to manage keys, and perform encryption during chat sessions.")
CMD_ARGS(
{ "gen", "Generate OMEMO crytographic materials for current account." },
{ "start [<contact>]", "Start an OMEMO session with contact, or current recipient if omitted." },
{ "end", "End the current OMEMO session." },
{ "log on|off", "Enable or disable plaintext logging of OMEMO encrypted messages." },
{ "log redact", "Log OMEMO encrypted messages, but replace the contents with [redacted]. This is the default." },
{ "fingerprint [<contact>]", "Show contact fingerprints, or current recipient if omitted." },
{ "char <char>", "Set the character to be displayed next to OMEMO encrypted messages." },
{ "trustmode manual", "Set the global OMEMO trust mode to manual, OMEMO keys has to be trusted manually." },
{ "trustmode firstusage", "Set the global OMEMO trust mode to ToFu, first OMEMO keys trusted automatically." },
{ "trustmode blind", "Set the global OMEMO trust mode to blind, ALL OMEMO keys trusted automatically." },
{ "policy manual", "Set the global OMEMO policy to manual, OMEMO sessions must be started manually." },
{ "policy automatic", "Set the global OMEMO policy to opportunistic, an OMEMO session will be attempted upon starting a conversation." },
{ "policy always", "Set the global OMEMO policy to always, an error will be displayed if an OMEMO session cannot be initiated upon starting a conversation." },
{ "clear_device_list", "Clear your own device list on server side. Each client will reannounce itself when connected back."})
CMD_EXAMPLES(
"/omemo gen",
"/omemo start odin@valhalla.edda",
"/omemo trust c4f9c875-144d7a3b-0c4a05b6-ca3be51a-a037f329-0bd3ae62-07f99719-55559d2a",
"/omemo untrust loki@valhalla.edda c4f9c875-144d7a3b-0c4a05b6-ca3be51a-a037f329-0bd3ae62-07f99719-55559d2a",
"/omemo char *")
},
{ "/save",
parse_args, 0, 0, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_save)
CMD_NOTAGS
CMD_SYN(
"/save")
CMD_DESC(
"Save preferences to configuration file.")
CMD_NOARGS
CMD_NOEXAMPLES
},
{ "/reload",
parse_args, 0, 0, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_reload)
CMD_NOTAGS
CMD_SYN(
"/reload")
CMD_DESC(
"Reload preferences from configuration file.")
CMD_NOARGS
CMD_NOEXAMPLES
},
{ "/paste",
parse_args, 0, 0, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_paste)
CMD_NOTAGS
CMD_SYN(
"/paste")
CMD_DESC(
"Paste clipboard.")
CMD_NOARGS
CMD_NOEXAMPLES
},
{ "/color",
parse_args, 1, 2, &cons_color_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_color)
CMD_TAGS(
CMD_TAG_UI)
CMD_SYN(
"/color on|off|redgreen|blue",
"/color own on|off")
CMD_DESC(
"Settings for consistent color generation for nicks (XEP-0392). Including corrections for Color Vision Deficiencies. "
"Your terminal needs to support 256 colors.")
CMD_ARGS(
{ "on|off|redgreen|blue", "Enable or disable nick colorization for MUC nicks. 'redgreen' is for people with red/green blindness and 'blue' for people with blue blindness." },
{ "own on|off", "Enable color generation for own nick. If disabled the color from the color from the theme ('me') will get used." })
CMD_EXAMPLES(
"/color off",
"/color on",
"/color blue",
"/color own off")
},
{ "/avatar",
parse_args, 2, 2, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_avatar)
CMD_TAGS(
CMD_TAG_CHAT)
CMD_SYN(
"/avatar get <barejid>",
"/avatar open <barejid>")
CMD_DESC(
"Download avatar (XEP-0084) for a certain contact. "
"If nothing happens after using this command the user either doesn't have an avatar set at all "
"or doesn't use XEP-0084 to publish it.")
CMD_ARGS(
{ "get <barejid>", "Download the avatar. barejid is the JID to download avatar from." },
{ "open <barejid>", "Download avatar and open it with command." })
CMD_EXAMPLES(
"/avatar get thor@valhalla.edda",
"/avatar open freyja@vanaheimr.edda") },
{ "/os",
parse_args, 1, 1, &cons_os_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_os)
CMD_TAGS(
CMD_TAG_DISCOVERY)
CMD_SYN(
"/os <on>|<off>")
CMD_DESC(
"Choose whether to include the OS name if a user asks for software information (XEP-0092).")
CMD_ARGS(
{ "on|off", "" })
CMD_NOEXAMPLES
},
{ "/correction",
parse_args, 1, 2, &cons_correction_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_correction)
CMD_TAGS(
CMD_TAG_UI,
CMD_TAG_CHAT,
CMD_TAG_GROUPCHAT)
CMD_SYN(
"/correction <on>|<off>",
"/correction char <char>")
CMD_DESC(
"Settings regarding Last Message Correction (XEP-0308). "
"Corrections will only work in MUC and regular chat windows. MUC PMs won't be allowed. "
"For more information on how to correct messages, see: /help correct.")
CMD_ARGS(
{ "on|off", "Enable/Disable support for last message correction." },
{ "char", "Set character that will prefix corrected messages. Default: '+'." })
CMD_NOEXAMPLES
},
{ "/correct",
parse_args_as_one, 1, 1, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_correct)
CMD_TAGS(
CMD_TAG_CHAT,
CMD_TAG_GROUPCHAT)
CMD_SYN(
"/correct <message>")
CMD_DESC(
"Correct and resend the last message (XEP-0308). "
"Use tab completion to get the last sent message. "
"For more information on how to configure corrections, see: /help correction.")
CMD_ARGS(
{ "message", "The corrected message." })
CMD_NOEXAMPLES
},
{ "/slashguard",
parse_args, 1, 1, &cons_slashguard_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_slashguard)
CMD_TAGS(
CMD_TAG_UI,
CMD_TAG_CHAT)
CMD_SYN(
"/slashguard on|off")
CMD_DESC(
"Slashguard won't accept a slash in the first 4 characters of your input field. "
"It tries to protect you from typing ' /quit' and similar things in chats.")
CMD_ARGS(
{ "on|off", "Enable or disable slashguard." })
CMD_NOEXAMPLES
},
{ "/serversoftware",
parse_args, 1, 1, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_serversoftware)
CMD_TAGS(
CMD_TAG_DISCOVERY)
CMD_SYN(
"/serversoftware <domain>")
CMD_DESC(
"Find server or component software version information.")
CMD_ARGS(
{ "<domain>", "The jid of your server or component." })
CMD_EXAMPLES(
"/serversoftware valhalla.edda",
"/serversoftware xmpp.vanaheimr.edda")
},
{ "/executable",
parse_args, 2, 4, &cons_executable_setting,
CMD_SUBFUNCS(
{ "avatar", cmd_executable_avatar },
{ "urlopen", cmd_executable_urlopen },
{ "urlsave", cmd_executable_urlsave },
{ "editor", cmd_executable_editor })
CMD_NOMAINFUNC
CMD_TAGS(
CMD_TAG_DISCOVERY)
CMD_SYN(
"/executable avatar <cmd>",
"/executable urlopen set <cmdtemplate>",
"/executable urlopen default",
"/executable urlsave set <cmdtemplate>",
"/executable urlsave default")
CMD_DESC(
"Configure executable that should be called upon a certain command.")
CMD_ARGS(
{ "avatar", "Set executable that is run by /avatar open. Use your favorite image viewer." },
{ "urlopen set", "Set executable that is run by /url open. Takes a command template that replaces %u and %p with the URL and path respectively." },
{ "urlopen default", "Restore to default settings." },
{ "urlsave set", "Set executable that is run by /url save. Takes a command template that replaces %u and %p with the URL and path respectively." },
{ "urlsave default", "Use the built-in download method for saving." },
{ "editor set", "Set editor to be used with /editor. Needs full file path." })
CMD_EXAMPLES(
"/executable avatar xdg-open",
"/executable urlopen set \"xdg-open %u\"",
"/executable urlopen set \"firefox %u\"",
"/executable urlopen default",
"/executable urlsave set \"wget %u -O %p\"",
"/executable urlsave set \"curl %u -o %p\"",
"/executable urlsave default",
"/executable editor set /usr/bin/vim")
},
{ "/url",
parse_args, 2, 3, NULL,
CMD_SUBFUNCS(
{ "open", cmd_url_open },
{ "save", cmd_url_save })
CMD_NOMAINFUNC
CMD_TAGS(
CMD_TAG_CHAT,
CMD_TAG_GROUPCHAT)
CMD_SYN(
"/url open <url>",
"/url save <url> [<path>]")
CMD_DESC(
"Deal with URLs")
CMD_ARGS(
{ "open", "Open URL with predefined executable." },
{ "save", "Save URL to optional path, default path is current directory" })
CMD_EXAMPLES(
"/url open https://profanity-im.github.io",
"/url save https://profanity-im.github.io/guide/latest/userguide.html /home/user/Download/")
},
{ "/mam",
parse_args, 1, 1, &cons_mam_setting,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_mam)
CMD_TAGS(
CMD_TAG_CHAT)
CMD_SYN(
"/mam <on>|<off>")
CMD_DESC(
"Enable/Disable Message Archive Management (XEP-0313)")
CMD_ARGS(
{ "on|off", "Enable or disable MAM" })
CMD_NOEXAMPLES
},
{ "/changepassword",
parse_args, 0, 0, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_change_password)
CMD_NOTAGS
CMD_SYN(
"/changepassword")
CMD_DESC(
"Change password of logged in account")
CMD_NOARGS
CMD_NOEXAMPLES
},
{ "/editor",
parse_args, 0, 0, NULL,
CMD_NOSUBFUNCS
CMD_MAINFUNC(cmd_editor)
CMD_TAGS(
CMD_TAG_CHAT,
CMD_TAG_GROUPCHAT)
CMD_SYN(
"/editor")
CMD_DESC(
"Spawn external editor to edit message")
CMD_NOARGS
CMD_NOEXAMPLES
},
// NEXT-COMMAND (search helper)
};
// clang-format on
static GHashTable* search_index;
char*
_cmd_index(Command* cmd)
{
GString* index_source = g_string_new("");
index_source = g_string_append(index_source, cmd->cmd);
index_source = g_string_append(index_source, " ");
index_source = g_string_append(index_source, cmd->help.desc);
index_source = g_string_append(index_source, " ");
int len = g_strv_length(cmd->help.tags);
for (int i = 0; i < len; i++) {
index_source = g_string_append(index_source, cmd->help.tags[i]);
index_source = g_string_append(index_source, " ");
}
len = g_strv_length(cmd->help.synopsis);
for (int i = 0; i < len; i++) {
index_source = g_string_append(index_source, cmd->help.synopsis[i]);
index_source = g_string_append(index_source, " ");
}
for (int i = 0; cmd->help.args[i][0] != NULL; i++) {
index_source = g_string_append(index_source, cmd->help.args[i][0]);
index_source = g_string_append(index_source, " ");
index_source = g_string_append(index_source, cmd->help.args[i][1]);
index_source = g_string_append(index_source, " ");
}
gchar** tokens = g_str_tokenize_and_fold(index_source->str, NULL, NULL);
g_string_free(index_source, TRUE);
GString* index = g_string_new("");
for (int i = 0; i < g_strv_length(tokens); i++) {
index = g_string_append(index, tokens[i]);
index = g_string_append(index, " ");
}
g_strfreev(tokens);
char* res = index->str;
g_string_free(index, FALSE);
return res;
}
GList*
cmd_search_index_any(char* term)
{
GList* results = NULL;
gchar** processed_terms = g_str_tokenize_and_fold(term, NULL, NULL);
int terms_len = g_strv_length(processed_terms);
for (int i = 0; i < terms_len; i++) {
GList* index_keys = g_hash_table_get_keys(search_index);
GList* curr = index_keys;
while (curr) {
char* index_entry = g_hash_table_lookup(search_index, curr->data);
if (g_str_match_string(processed_terms[i], index_entry, FALSE)) {
results = g_list_append(results, curr->data);
}
curr = g_list_next(curr);
}
g_list_free(index_keys);
}
g_strfreev(processed_terms);
return results;
}
GList*
cmd_search_index_all(char* term)
{
GList* results = NULL;
gchar** terms = g_str_tokenize_and_fold(term, NULL, NULL);
int terms_len = g_strv_length(terms);
GList* commands = g_hash_table_get_keys(search_index);
GList* curr = commands;
while (curr) {
char* command = curr->data;
int matches = 0;
for (int i = 0; i < terms_len; i++) {
char* command_index = g_hash_table_lookup(search_index, command);
if (g_str_match_string(terms[i], command_index, FALSE)) {
matches++;
}
}
if (matches == terms_len) {
results = g_list_append(results, command);
}
curr = g_list_next(curr);
}
g_list_free(commands);
g_strfreev(terms);
return results;
}
/*
* Initialise command autocompleter and history
*/
void
cmd_init(void)
{
log_info("Initialising commands");
cmd_ac_init();
search_index = g_hash_table_new_full(g_str_hash, g_str_equal, free, g_free);
// load command defs into hash table
commands = g_hash_table_new(g_str_hash, g_str_equal);
for (unsigned int i = 0; i < ARRAY_SIZE(command_defs); i++) {
Command* pcmd = command_defs + i;
// add to hash
g_hash_table_insert(commands, pcmd->cmd, pcmd);
// add to search index
g_hash_table_insert(search_index, strdup(pcmd->cmd), _cmd_index(pcmd));
// add to commands and help autocompleters
cmd_ac_add_cmd(pcmd);
}
// load aliases
GList* aliases = prefs_get_aliases();
GList* curr = aliases;
while (curr) {
ProfAlias* alias = curr->data;
cmd_ac_add_alias(alias);
curr = g_list_next(curr);
}
prefs_free_aliases(aliases);
}
void
cmd_uninit(void)
{
cmd_ac_uninit();
g_hash_table_destroy(search_index);
}
gboolean
cmd_valid_tag(const char* const str)
{
return ((g_strcmp0(str, CMD_TAG_CHAT) == 0) || (g_strcmp0(str, CMD_TAG_GROUPCHAT) == 0) || (g_strcmp0(str, CMD_TAG_PRESENCE) == 0) || (g_strcmp0(str, CMD_TAG_ROSTER) == 0) || (g_strcmp0(str, CMD_TAG_DISCOVERY) == 0) || (g_strcmp0(str, CMD_TAG_CONNECTION) == 0) || (g_strcmp0(str, CMD_TAG_UI) == 0) || (g_strcmp0(str, CMD_TAG_PLUGINS) == 0));
}
Command*
cmd_get(const char* const command)
{
if (commands) {
return g_hash_table_lookup(commands, command);
} else {
return NULL;
}
}
GList*
cmd_get_ordered(const char* const tag)
{
GList* ordered_commands = NULL;
GHashTableIter iter;
gpointer key;
gpointer value;
g_hash_table_iter_init(&iter, commands);
while (g_hash_table_iter_next(&iter, &key, &value)) {
Command* pcmd = (Command*)value;
if (tag) {
if (_cmd_has_tag(pcmd, tag)) {
ordered_commands = g_list_insert_sorted(ordered_commands, pcmd->cmd, (GCompareFunc)g_strcmp0);
}
} else {
ordered_commands = g_list_insert_sorted(ordered_commands, pcmd->cmd, (GCompareFunc)g_strcmp0);
}
}
return ordered_commands;
}
static gboolean
_cmd_has_tag(Command* pcmd, const char* const tag)
{
for (int i = 0; pcmd->help.tags[i] != NULL; i++) {
if (g_strcmp0(tag, pcmd->help.tags[i]) == 0) {
return TRUE;
}
}
return FALSE;
}
static int
_cmp_command(Command* cmd1, Command* cmd2)
{
return g_strcmp0(cmd1->cmd, cmd2->cmd);
}
void
command_docgen(void)
{
GList* cmds = NULL;
for (unsigned int i = 0; i < ARRAY_SIZE(command_defs); i++) {
Command* pcmd = command_defs + i;
cmds = g_list_insert_sorted(cmds, pcmd, (GCompareFunc)_cmp_command);
}
FILE* toc_fragment = fopen("toc_fragment.html", "w");
FILE* main_fragment = fopen("main_fragment.html", "w");
fputs("<ul><li><ul><li>\n", toc_fragment);
fputs("<hr>\n", main_fragment);
GList* curr = cmds;
while (curr) {
Command* pcmd = curr->data;
fprintf(toc_fragment, "<a href=\"#%s\">%s</a>,\n", &pcmd->cmd[1], pcmd->cmd);
fprintf(main_fragment, "<a name=\"%s\"></a>\n", &pcmd->cmd[1]);
fprintf(main_fragment, "<h4>%s</h4>\n", pcmd->cmd);
fputs("<p><b>Synopsis</b></p>\n", main_fragment);
fputs("<p><pre><code>", main_fragment);
int i = 0;
while (pcmd->help.synopsis[i]) {
char* str1 = str_replace(pcmd->help.synopsis[i], "<", "<");
char* str2 = str_replace(str1, ">", ">");
fprintf(main_fragment, "%s\n", str2);
i++;
}
fputs("</code></pre></p>\n", main_fragment);
fputs("<p><b>Description</b></p>\n", main_fragment);
fputs("<p>", main_fragment);
fprintf(main_fragment, "%s\n", pcmd->help.desc);
fputs("</p>\n", main_fragment);
if (pcmd->help.args[0][0] != NULL) {
fputs("<p><b>Arguments</b></p>\n", main_fragment);
fputs("<table>", main_fragment);
for (i = 0; pcmd->help.args[i][0] != NULL; i++) {
fputs("<tr>", main_fragment);
fputs("<td>", main_fragment);
fputs("<code>", main_fragment);
char* str1 = str_replace(pcmd->help.args[i][0], "<", "<");
char* str2 = str_replace(str1, ">", ">");
fprintf(main_fragment, "%s", str2);
fputs("</code>", main_fragment);
fputs("</td>", main_fragment);
fputs("<td>", main_fragment);
fprintf(main_fragment, "%s", pcmd->help.args[i][1]);
fputs("</td>", main_fragment);
fputs("</tr>", main_fragment);
}
fputs("</table>\n", main_fragment);
}
if (pcmd->help.examples[0] != NULL) {
fputs("<p><b>Examples</b></p>\n", main_fragment);
fputs("<p><pre><code>", main_fragment);
int i = 0;
while (pcmd->help.examples[i]) {
fprintf(main_fragment, "%s\n", pcmd->help.examples[i]);
i++;
}
fputs("</code></pre></p>\n", main_fragment);
}
fputs("<a href=\"#top\"><h5>back to top</h5></a><br><hr>\n", main_fragment);
fputs("\n", main_fragment);
curr = g_list_next(curr);
}
fputs("</ul></ul>\n", toc_fragment);
fclose(toc_fragment);
fclose(main_fragment);
printf("\nProcessed %d commands.\n\n", g_list_length(cmds));
g_list_free(cmds);
}
void
command_mangen(void)
{
GList* cmds = NULL;
for (unsigned int i = 0; i < ARRAY_SIZE(command_defs); i++) {
Command* pcmd = command_defs + i;
cmds = g_list_insert_sorted(cmds, pcmd, (GCompareFunc)_cmp_command);
}
mkdir_recursive("docs");
GDateTime* now = g_date_time_new_now_local();
gchar* date = g_date_time_format(now, "%F");
gchar* header = g_strdup_printf(".TH man 1 \"%s\" \"" PACKAGE_VERSION "\" \"Profanity XMPP client\"\n", date);
if (!header) {
log_error("command_mangen(): could not allocate memory");
return;
}
g_date_time_unref(now);
g_free(date);
GList* curr = cmds;
while (curr) {
Command* pcmd = curr->data;
gchar* filename = g_strdup_printf("docs/profanity-%s.1", &pcmd->cmd[1]);
if (!filename) {
log_error("command_mangen(): could not allocate memory");
return;
}
FILE* manpage = fopen(filename, "w");
free(filename);
fprintf(manpage, "%s\n", header);
fputs(".SH NAME\n", manpage);
fprintf(manpage, "%s\n", pcmd->cmd);
fputs("\n.SH DESCRIPTION\n", manpage);
fprintf(manpage, "%s\n", pcmd->help.desc);
fputs("\n.SH SYNOPSIS\n", manpage);
int i = 0;
while (pcmd->help.synopsis[i]) {
fprintf(manpage, "%s\n", pcmd->help.synopsis[i]);
fputs("\n.LP\n", manpage);
i++;
}
if (pcmd->help.args[0][0] != NULL) {
fputs("\n.SH ARGUMENTS\n", manpage);
for (i = 0; pcmd->help.args[i][0] != NULL; i++) {
fprintf(manpage, ".PP\n\\fB%s\\fR\n", pcmd->help.args[i][0]);
fprintf(manpage, ".RS 4\n%s\n.RE\n", pcmd->help.args[i][1]);
}
}
if (pcmd->help.examples[0] != NULL) {
fputs("\n.SH EXAMPLES\n", manpage);
int i = 0;
while (pcmd->help.examples[i]) {
fprintf(manpage, "%s\n", pcmd->help.examples[i]);
fputs("\n.LP\n", manpage);
i++;
}
}
fclose(manpage);
curr = g_list_next(curr);
}
printf("\nProcessed %d commands.\n\n", g_list_length(cmds));
g_free(header);
g_list_free(cmds);
}
|