summaryrefslogtreecommitdiff
path: root/doc/en/weechat_user.en.txt
blob: a87df0a10490089256acf95ee63aa20a861f23bc (plain)
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
WeeChat User's Guide
====================
Sébastien Helleu <flashcode@flashtux.org>


This manual documents WeeChat chat client, it is part of WeeChat.

Latest version of this document can be found on this page:
http://www.weechat.org/doc


[[introduction]]
Introduction
------------

WeeChat (Wee Enhanced Environment for Chat) is a free chat client, fast and
light, designed for many operating systems.

[[features]]
Features
~~~~~~~~

Main features are:

* multi-protocols (IRC, Jabber)
* multi-servers connection (with SSL, IPv6, proxy)
* small, fast and light
* customizable and extensible with plugins and scripts
* compliant with IRC RFCs http://tools.ietf.org/html/rfc1459[1459],
  http://tools.ietf.org/html/rfc2810[2810],
  http://tools.ietf.org/html/rfc2811[2811],
  http://tools.ietf.org/html/rfc2812[2812] and
  http://tools.ietf.org/html/rfc2813[2813]
* multi-platform (GNU/Linux, *BSD, MacOS X, Windows and other)
* 100% GPL, free software

WeeChat homepage is here: http://www.weechat.org/

[[pre-requisites]]
Pre-requisites
~~~~~~~~~~~~~~

In order to install WeeChat, you need:

* a running GNU/Linux system (with compiler tools for source
  package), or compatible OS
* 'root' privileges (to install WeeChat in a system directory)
* ncurses library

[[install]]
Installation
------------

[[binary_packages]]
Binary packages
~~~~~~~~~~~~~~~

Binary packages are available for many distributions, including:

* Debian (or any Debian compatible distribution):
  `apt-get install weechat-curses`
* Mandriva/RedHat (or any RPM compatible distribution):
  `rpm -i /path/to/weechat-x.y.z-1.i386.rpm`
* Gentoo: `emerge weechat`
* Arch Linux: `pacman -S weechat`
* Fedora Core: `yum install weechat`
* Sourcemage: `cast weechat`

Some additional packages may be useful, like weechat-plugins.

For other distributions, please look at your manual for installation
instructions.

[[source_package]]
Source package
~~~~~~~~~~~~~~

WeeChat can be compiled with cmake or autotools (cmake is recommended way).

[[dependencies]]
Dependencies
^^^^^^^^^^^^

Following table shows list of packages that are required or optional to
compile WeeChat.

[width="100%",cols="5,^3,^3,13",options="header"]
|========================================
| Package ^(1)^          | Version     | Required | Feature
| cmake                  |             | *yes*    | build (autotools still possible, but cmake is recommended)
| libncursesw5-dev ^(2)^ |             | *yes*    | ncurses interface
| libcurl4-gnutls-dev    |             | *yes*    | URL transfer
| zlib1g-dev             |             | *yes*    | compression of packets in relay plugin (weechat protocol), script plugin
| libgcrypt11-dev        |             | *yes*    | SASL authentication with IRC server using DH-BLOWFISH mechanism, script plugin
| libgnutls-dev          | ≥ 2.2.0     |          | SSL connection to IRC server, support of SSL in relay plugin
| gettext                |             |          | internationalization (translation of messages; base language is English)
| ca-certificates        |             |          | certificates for SSL connections
| libaspell-dev          |             |          | aspell plugin
| python-dev             | ≥ 2.5 ^(3)^ |          | python plugin
| libperl-dev            |             |          | perl plugin
| ruby1.9.1-dev          | ≥ 1.8       |          | ruby plugin
| liblua5.1-0-dev        |             |          | lua plugin
| tcl-dev                | ≥ 8.5       |          | tcl plugin
| guile-1.8-dev          | ≥ 1.8       |          | guile (scheme) plugin
| asciidoc               | ≥ 8.5.0     |          | build documentation (HTML files)
| source-highlight       |             |          | syntax highlight for sources in HTML documentation
|========================================

[NOTE]
^(1)^ Name comes from the Debian GNU/Linux distribution, versions and package
names may be different in different distributions and versions. +
^(2)^ WeeChat can compile with libncurses5-dev, but it is *NOT* recommended (you
will have display bugs with wide chars). +
^(3)^ Recommended Python version is 2.7 (all scripts run fine with version 2.7,
but not with versions ≤ 2.6 or ≥ 3.0).

[[compile_with_cmake]]
Compile with cmake
^^^^^^^^^^^^^^^^^^

* Installation in system directories (requires 'root' privileges):

----------------------------------------
$ mkdir build
$ cd build
$ cmake ..
$ make
% make install    (as root)
----------------------------------------

* Installation in custom directory:

----------------------------------------
$ mkdir build
$ cd build
$ cmake .. -DPREFIX=/path/to/directory
$ make
$ make install
----------------------------------------

[[compile_with_autotools]]
Compile with autotools
^^^^^^^^^^^^^^^^^^^^^^

[WARNING]
Only cmake is officially supported to build WeeChat. You should use autotools
only if you are not able to use cmake. +
Build with autotools requires more dependencies and is slower than with cmake.

* Installation in system directories (requires 'root' privileges):

----------------------------------------
$ ./autogen.sh
$ ./configure
$ make
% make install    (as root)
----------------------------------------

* Installation in custom directory:

----------------------------------------
$ ./autogen.sh
$ ./configure --prefix=/path/to/directory
$ make
$ make install
----------------------------------------

[[git_sources]]
Git sources
~~~~~~~~~~~

Warning: git sources are for advanced users: it may not compile or not be
stable. You're warned!

To get git sources, issue this command:

----------------------------------------
$ git clone git://git.sv.gnu.org/weechat.git
----------------------------------------

Then follow instructions for source package (see
<<source_package,source package>>).

[[report_crashes]]
Report crashes
~~~~~~~~~~~~~~

If you experienced crashes, or if you want to report any future WeeChat crash,
you have to:

* compile it with debug info (or install binary package with debug info)
* enable 'core' files on your system
* install gdb

[[debug_info]]
Debug info
^^^^^^^^^^

If you're compiling with cmake:

----------------------------------------
$ cmake .. -DCMAKE_BUILD_TYPE=Debug
----------------------------------------

If you're compiling with autotools, debug is default (`--with-debug=1`).

If you installed a binary package, then install package 'weechat-dbg'.

[[core_files]]
Core files
^^^^^^^^^^

To enable 'core' files, you can use option
<<option_weechat.startup.sys_rlimit,weechat.startup.sys_rlimit>>:

----------------------------------------
/set weechat.startup.sys_rlimit "core:-1"
----------------------------------------

For WeeChat ≤ 0.3.8 or if you want to enable core files even before WeeChat
starts, you can use `ulimit` command.

For example under Linux with 'bash' shell, add this line to your `~/.bashrc`:

----------------------------------------
ulimit -c unlimited
----------------------------------------

Or max size:

----------------------------------------
ulimit -c 200000
----------------------------------------

[[gdb_backtrace]]
Get backtrace with gdb
^^^^^^^^^^^^^^^^^^^^^^

When WeeChat crashes, your system will create a file 'core' or 'core.12345'
('12345' is process id).
This file is created in directory where you have run WeeChat (this is *not*
directory where WeeChat is installed!).

For example if 'weechat-curses' is installed in '/usr/bin/' and 'core' file is
in '/home/xxx/', then run gdb with this command:

----------------------------------------
gdb /usr/bin/weechat-curses /home/xxx/core
----------------------------------------

[NOTE]
If you installed binary package 'weechat-dbg' (for example under Debian), then
you can use this path for WeeChat binary: '/usr/lib/debug/usr/bin/weechat-curses'

Then under gdb, use command `bt full` to display backtrace.
You will see something like that:

----------------------------------------
(gdb) set logging file /tmp/crash.txt
(gdb) set logging on
Copying output to /tmp/crash.txt.
(gdb) bt full
#0  0x00007f9dfb04a465 in raise () from /lib/libc.so.6
#1  0x00007f9dfb04b8e6 in abort () from /lib/libc.so.6
#2  0x0000000000437f66 in weechat_shutdown (return_code=1, crash=1) at /some_path/src/core/weechat.c:351
#3  <signal handler called>
#4  0x000000000044cb24 in hook_process_timer_cb (arg_hook_process=0x254eb90, remaining_calls=<value optimized out>)
    at /some_path/src/core/wee-hook.c:1364
        hook_process = 0x254eb90
        status = <value optimized out>
#5  0x000000000044cc7d in hook_timer_exec () at /some_path/src/core/wee-hook.c:1025
        tv_time = {tv_sec = 1272693881, tv_usec = 212665}
        ptr_hook = 0x2811f40
        next_hook = 0x0
#6  0x000000000041b5b0 in gui_main_loop () at /some_path/src/gui/curses/gui-curses-main.c:319
        hook_fd_keyboard = 0x173b600
        tv_timeout = {tv_sec = 0, tv_usec = 0}
        read_fds = {fds_bits = {0 <repeats 16 times>}}
        write_fds = {fds_bits = {0 <repeats 16 times>}}
        except_fds = {fds_bits = {0 <repeats 16 times>}}
        max_fd = <value optimized out>
----------------------------------------

You must report this trace to developers, and tell them what action caused this
crash.

Thank you for your help!

[[debug_running_weechat]]
Debug a running WeeChat
^^^^^^^^^^^^^^^^^^^^^^^

To debug a running WeeChat (for example if WeeChat seems blocked), you can use
gdb with process id (replace '12345' with PID of weechat-curses process):

----------------------------------------
gdb /usr/bin/weechat-curses 12345
----------------------------------------

Then like for a crash, use command `bt full`:

----------------------------------------
(gdb) bt full
----------------------------------------

[[usage]]
Usage
-----

[[running_weechat]]
Running WeeChat
~~~~~~~~~~~~~~~

Command line arguments:

-a, --no-connect::
    Disable auto-connect to servers when WeeChat is starting.

-c, --colors::
    Display default colors in terminal.

-d, --dir 'path'::
    Set path as home for WeeChat (used for configuration files, logs, user
    plugins and scripts), default value is '~/.weechat' (note: directory is
    created if not found by WeeChat).

-h, --help::
    Display help.

-k, --keys::
    Display WeeChat default keys.

-l, --license::
    Display WeeChat license.

-p, --no-plugin::
    Disable plugins auto-load.

-r, --run-command::
    Run command(s) after startup (many commands can be separated by semicolons).

-s, --no-script::
    Disable scripts auto-load.

-v, --version::
    Display WeeChat version.

plugin:option::
    Option for plugin (see doc for each plugin).

To start WeeChat, issue this command:

----------------------------------------
$ weechat-curses
----------------------------------------

When you run WeeChat for the first time, a default configuration file is
created, with default options. The default configuration file is:
'~/.weechat/weechat.conf'.

You can edit this file at your convenience to configure WeeChat or you can set
parameters with `/set` command in WeeChat (see
<<weechat_commands,WeeChat commands>>).

[[screen_layout]]
Screen layout
~~~~~~~~~~~~~

Example of terminal with WeeChat:

........................................
┌─────────────────────────────────────────────────────────────────────────────────────────┐
│Welcome to #test, this is a test channel                                                 │ ◀ bar "title"
│12:52:27   --> | Flashy (flashcode@weechat.org) has joined #test                 │@Flashy│
│12:52:27    -- | Nicks #test: [@Flashy @joe +weebot]                             │@joe   │
│12:52:27    -- | Channel #test: 4 nicks (2 ops, 0 halfop, 1 voice, 1 normal)     │+weebot│
│12:52:27    -- | Channel created on Tue Jan 27 06:30:17 2009                     │peter  │
│12:54:15 peter | hey!                                                            │       │
│12:55:01  @joe | hello                                                           │       │
│                                                                                 │       │
│                                                                                 │       │
│                                                                                 │       │
│                                                                                 │       │ ◀ chat + bar "nicklist"
│                                                                                 │       │
│                                                                                 │       │
│                                                                                 │       │
│                                                                                 │       │
│                                                                                 │       │
│                                                                                 │       │
│                                                                                 │       │
│                                                                                 │       │
│                                                                                 │       │
│                                                                                 │       │
│[12:55] [6] [irc/freenode] 3:#test(+n){4}* [Act: 4:#abc(2,5), 6]                         │ ◀ bar "status"
│[@Flashy] hi peter!█                                                                     │ ◀ bar "input"
└─────────────────────────────────────────────────────────────────────────────────────────┘
........................................

Screen is composed by following areas:

* chat area (middle of screen) with chat lines, and for each line:
** time
** prefix (before "|")
** message (after "|")
* bars around chat area, default bars are:
** 'title' bar, above chat area
** 'status' bar, below chat area
** 'input' bar, below status bar
** 'nicklist' bar, on the right

Bar 'status' has following default items:

[width="100%",cols="^3,^3l,10",options="header"]
|========================================
| Item                  | Example               | Description
| time                  | [12:55]               | time
| buffer_count          | [6]                   | number of opened buffers
| buffer_plugin         | [irc/freenode]        | plugin of current buffer (irc plugin can add IRC server name used by buffer)
| buffer_number         | 3                     | current buffer number
| buffer_name           | #test                 | current buffer name
| buffer_modes          | +n                    | IRC channel modes
| buffer_nicklist_count | {4}                   | number of nicks in nicklist
| buffer_filter         | *                     | filtering indicator: `*` means some lines are filtered (hidden), empty value means all lines are displayed
| lag                   | [Lag: 2.5]            | lag indicator, in seconds (hidden if lag is low)
| hotlist               | [Act: 4:#abc(2,5), 6] | list of buffers with activity (unread messages) (in example, 2 highlights and 5 unread messages on '#abc', one unread message on buffer #6)
| completion            | abc(2) def(5)         | list of words for completion, with number of possible completions for each word
| scroll                | -MORE(50)-            | scroll indicator, with number of lines below last line displayed
|========================================

Bar 'input' has following default items:

[width="100%",cols="^3,^6l,8",options="header"]
|========================================
| Item         | Example                                    | Description
| input_paste  | [Paste 7 lines ? [ctrl-Y] Yes [ctrl-N] No] | question to user for pasting lines
| input_prompt | [@Flashy]                                  | input prompt (nick for irc plugin)
| away         | (away)                                     | away indicator
| input_search | [Text search]                              | text search indicator
| input_text   | hi peter!                                  | input text
|========================================

[[buffers_and_windows]]
Buffers and windows
~~~~~~~~~~~~~~~~~~~

A 'buffer' is composed by a number, a name, lines displayed (and some other
data).

Examples of buffers:

* core buffer (created by WeeChat on startup, can not be closed)
* irc server (displays messages from server)
* irc channel
* irc private

A 'window' is a screen area which displays a buffer. It is possible to split
your screen into many windows.

Each window displays one buffer. A buffer can be hidden (not displayed by a
window) or displayed by one or more windows.

Example of horizontal split (`/window splith`):

........................................
┌─────────────────────────────────────────────────────────────────────────────────────────┐
│Welcome to #abc, channel about nothing!                                                  │
│12:55:12     Max | hi                                                            │@Flashy│
│12:55:20 @Flashy | hi Max!                                                       │Max    │
│12:55:32     Max | how are you?                                                  │       │
│                                                                                 │       │
│                                                                                 │       │ ◀ window #2
│                                                                                 │       │   (buffer #4)
│                                                                                 │       │
│                                                                                 │       │
│[12:55] [6] [irc/freenode] 4:#abc(+n){2}                                                 │
│[@Flashy]                                                                                │
│─────────────────────────────────────────────────────────────────────────────────────────│
│Welcome to #test, this is a test channel                                                 │
│12:54:15 peter | hey!                                                            │@Flashy│
│12:55:01  @joe | hello                                                           │@joe   │
│                                                                                 │+weebot│
│                                                                                 │peter  │
│                                                                                 │       │ ◀ window #1
│                                                                                 │       │   (buffer #3)
│                                                                                 │       │
│                                                                                 │       │
│[12:55] [6] [irc/freenode] 3:#test(+n){4}                                                │
│[@Flashy] hi peter!█                                                                     │
└─────────────────────────────────────────────────────────────────────────────────────────┘
........................................

Example of vertical split (`/window splitv`):

........................................
┌─────────────────────────────────────────────────────────────────────────────────────────┐
│Welcome to #test, this is a test channel    │Welcome to #abc, channel about nothing!     │
│12:54:15 peter | hey!               │@Flashy│12:55:12     Max | hi               │@Flashy│
│12:55:01  @joe | hello              │@joe   │12:55:20 @Flashy | hi Max!          │Max    │
│                                    │+weebot│12:55:32     Max | how are you?     │       │
│                                    │peter  │                                    │       │
│                                    │       │                                    │       │
│                                    │       │                                    │       │
│                                    │       │                                    │       │
│                                    │       │                                    │       │
│                                    │       │                                    │       │
│                                    │       │                                    │       │
│                                    │       │                                    │       │
│                                    │       │                                    │       │
│                                    │       │                                    │       │
│                                    │       │                                    │       │
│                                    │       │                                    │       │
│                                    │       │                                    │       │
│                                    │       │                                    │       │
│                                    │       │                                    │       │
│                                    │       │                                    │       │
│                                    │       │                                    │       │
│[12:55] [6] [irc/freenode] 3:#test(+n){4}   │[12:55] [6] [irc/freenode] 4:#abc(+n){2}    │
│[@Flashy] hi peter!█                        │[@Flashy]                                   │
└─────────────────────────────────────────────────────────────────────────────────────────┘
                ▲ window #1                                   ▲ window #2
                  (buffer #3)                                   (buffer #4)
........................................

Example of vertical + horizontal splits:

........................................
┌─────────────────────────────────────────────────────────────────────────────────────────┐
│Welcome to #test, this is a test channel    │Welcome to #def, another channel            │
│12:54:15 peter | hey!               │@Flashy│12:55:42 @Flashy | hello world      │@Flashy│
│12:55:01  @joe | hello              │@joe   │12:55:56    alex | hi Flashy        │alex   │
│                                    │+weebot│                                    │       │
│                                    │peter  │                                    │       │ ◀ window #3
│                                    │       │                                    │       │   (buffer #5)
│                                    │       │                                    │       │
│                                    │       │                                    │       │
│                                    │       │                                    │       │
│                                    │       │[12:55] [6] [irc/freenode] 5:#def(+n){2}    │
│                                    │       │[@Flashy]                                   │
│                                    │       │────────────────────────────────────────────│
│                                    │       │Welcome to #abc, channel about nothing!     │
│                                    │       │12:55:12     Max | hi               │@Flashy│
│                                    │       │12:55:20 @Flashy | hi Max!          │Max    │
│                                    │       │12:55:32     Max | how are you?     │       │
│                                    │       │                                    │       │
│                                    │       │                                    │       │ ◀ window #2
│                                    │       │                                    │       │   (buffer #4)
│                                    │       │                                    │       │
│                                    │       │                                    │       │
│[12:55] [6] [irc/freenode] 3:#test(+n){4}   │ [12:55] [6] [irc/freenode] 4:#abc(+n){2}   │
│[@Flashy] hi peter!█                        │ [@Flashy]                                  │
└─────────────────────────────────────────────────────────────────────────────────────────┘
                ▲ window #1
                  (buffer #3)
........................................

[[bars]]
Bars
~~~~

A 'bar' is an area beside the chat that can contain any type of text.

The bar options can be set with options `weechat.bar.name.option` where `name`
is the name of the bar and `option` the option for this bar.

List of bar options:

[width="100%",cols="2m,2,10",options="header"]
|========================================
| Option | Values | Description

| type | `root`, `window` |
  A bar with type `root` is displayed exactly one time on screen, outside all
  windows. There is no root bar by default, but an example is the bar 'buffers'
  created by script 'buffers.pl' (sidebar with list of buffers). +
  A bar with type `window` is displayed in each window, for example if you
  split one time the screen (with `/window splith` or `/window splitv`), you
  will have one bar in each window. The four default bars ('title', 'status',
  'input', 'nicklist') have type `window`.

| position | `top`, `bottom`, `left`, `right` |
  Position of the bar: above/below chat, on the left/right.

| priority | integer ≥ 0 |
  Priority for display of bar: this is used for ordering the bars on screen when
  many bars have same type and position. +
  The bars are displayed from the edge of the screen to the center. A higher
  priority will display bar at the beginning, so closer to the edge. +
  Example: 'input' bar has priority 1000, so it is displayed before the 'status'
  bar, which has priority 500.

| size | integer ≥ 0 |
  The size of the bar: number of columns for position left/right, number
  of lines for position top/bottom. A size of `0` means automatic, so the size
  will be computed according to content displayed in bar.

| size_max | integer ≥ 0 |
  The maximum size for a bar, `0` = no limit (this option is used only if
  `size` = `0`).

| color_bg | color |
  The default background color for the bar.

| color_fg | color |
  The default text color for the bar.

| color_delim | color |
  The color for delimiters in bar.

| hidden | `on`, `off` |
  When option is `on`, the bar is hidden. +
  Note: instead of changing this option, the command `/bar` is preferred, for
  example: `/bar toggle nicklist` (see command <<command_weechat_bar,/bar>>).

| separator | `on`, `off` |
  When option is `on`, a separator (line) is displayed between this bar and
  other bars (or chat).

| items | string |
  A list of 'items' (see <<bar_items,items>> for more info).

| filling_left_right | `horizontal`, `vertical`, `columns_horizontal`, `columns_vertical` |
  Type of filling for a bar which has position `left` or `right` (see
  <<bar_filling,filling>> for more info).

| filling_top_bottom | `horizontal`, `vertical`, `columns_horizontal`, `columns_vertical` |
  Type of filling for a bar which has position `top` or `bottom` (see
  <<bar_filling,filling>> for more info).

| conditions | string |
  The conditions to display the bar (see <<bar_conditions,conditions>> for more
  info).
|========================================

[[bar_items]]
Items
^^^^^

The option 'items' is a string with a list of bar items, separated by a comma
(space between items on screen) or "+" (glued items).

The list of bar items is displayed with command `/bar listitems`.

Example of bar with items "[time],buffer_number+:+buffer_plugin+.+buffer_name":

........................................
┌─────────────────────────────────────────────────────────────────────────────────────────┐
│[12:55] 3:irc/freenode.#weechat                                                          │
└─────────────────────────────────────────────────────────────────────────────────────────┘
........................................

[[bar_filling]]
Filling
^^^^^^^

There are four types of filling:

* `horizontal`: the items are displayed horizontally, from left to right. If
  there are new lines in items, a space is used to separate lines.
* `vertical`: the items are displayed from top to bottom. If there are new
  lines in items, a new line is used to separate lines.
* `columns_horizontal`: items are displayed using columns, where text is
  aligned on the left. The first item is on top left, the second is on same
  line, on the right.
* `columns_vertical`: items are displayed using columns, where text is aligned
  on the left. The first item is on top left, the second is one line below.

Default bars 'title', 'status' and 'input' have 'horizontal' filling, and
default bar 'nicklist' has 'vertical' filling.

Some examples of filling for bar 'nicklist':

........................................
┌──────────────────────────────────────────────────┐
│Welcome to #test, this is a test channel          │
│12:54:15 peter | hey!                    │@carl   │
│12:55:01  +Max | hello                   │@jessika│
│                                         │@maddy  │
│                                         │%Diego  │
│                                         │%Melody │
│                                         │+Max    │
│                                         │ celia  │
│                                         │ Eva    │
│                                         │ freddy │
│                                         │ Harold^│
│                                         │ henry4 │
│                                         │ jimmy17│
│                                         │ jodie ▼│
│[12:55] [6] [irc/freenode] 3:#test(+n){24}        │
└──────────────────────────────────────────────────┘
                filling_left_right = vertical ▲

┌──────────────────────────────────────────────────┐
│Welcome to #test, this is a test channel          │
│12:54:15 peter | hey!           │@carl     lee    │
│12:55:01  +Max | hello          │@jessika  louise │
│                                │@maddy    mario  │
│                                │%Diego    mark   │
│                                │%Melody   peter  │
│                                │+Max      Rachel │
│                                │ celia    richard│
│                                │ Eva      sheryl │
│                                │ freddy   Vince  │
│                                │ Harold^  warren │
│                                │ henry4   zack   │
│                                │ jimmy17         │
│                                │ jodie           │
│[12:55] [6] [irc/freenode] 3:#test(+n){24}        │
└──────────────────────────────────────────────────┘
        filling_left_right = columns_vertical ▲

┌───────────────────────────────────────────────────────────────────────┐
│@carl    %Diego    celia    Harold^  jodie    mario    Rachel   Vince  │
│@jessika %Melody   Eva      henry4   lee      mark     richard  warren │
│@maddy   +Max      freddy   jimmy17  louise   peter    sheryl   zack   │
│───────────────────────────────────────────────────────────────────────│
│                                                                       │
        filling_top_bottom = columns_vertical ▲

┌───────────────────────────────────────────────────────────────────────┐
│@carl    @jessika @maddy   %Diego   %Melody  +Max      celia    Eva    │
│ freddy   Harold^  henry4   jimmy17  jodie    lee      louise   mario  │
│ mark     peter    Rachel   richard  sheryl   Vince    warren   zack   │
│───────────────────────────────────────────────────────────────────────│
│                                                                       │
      filling_top_bottom = columns_horizontal ▲
........................................

[[bar_conditions]]
Conditions
^^^^^^^^^^

The option 'conditions' is a string evaluated to know if the bar is displayed
or not in the window (it is used only for bars with type 'window').

The string can be:

* 'active': the window must be active
* 'inactive': the window must be inactive
* 'nicklist': the buffer displayed in window must have a nicklist
* an expression: it is evaluated as boolean (see command
  <<command_weechat_eval,/eval>>)

For the expression, following variables are available:

* `${active}`: true if window is active
* `${inactive}`: true if window is inactive
* `$[nicklist}`: true if buffer displayed in window has a nicklist

Following pointers are available:

* `${window}`: the window where condition is evaluated
* `${buffer}`: the buffer of window where condition is evaluated

Example to display nicklist bar in all buffers with a nicklist, and only if
width of window is > 100 :

----------------------------------------
/set weechat.bar.nicklist.conditions "${nicklist} && ${window.win_width} > 100"
----------------------------------------

Same condition, but always display nicklist on buffer '&bitlbee' (even if window
is small):

----------------------------------------
/set weechat.bar.nicklist.conditions "${nicklist} && (${window.win_width} > 100 || ${buffer.full_name} == irc.bitlbee.&bitlbee)"
----------------------------------------

[[notify_levels]]
Notify levels
~~~~~~~~~~~~~

Four levels are possible in messages displayed in buffers, from lower to higher:

* 'low': message with low importance (for example irc join/part/quit)
* 'message': message from a user
* 'private': message in a private buffer
* 'highlight': message with highlight

Each buffer has a notify level, which is used to decide what messages will add
buffer in hotlist.

The default notify level can be set using option
<<option_weechat.look.buffer_notify_default,weechat.look.buffer_notify_default>>,
default is 'all'.

[width="50%",cols="3m,10",options="header"]
|========================================
| Notify level | Level of messages added to hotlist
| none         | (none)
| highlight    | 'highlight' + 'private'
| message      | 'highlight' + 'private' + 'message'
| all          | 'highlight' + 'private' + 'message' + 'low'
|========================================

Notify level can be defined for a set of buffers, for example all buffers of
irc server "freenode":

----------------------------------------
/set weechat.notify.irc.freenode message
----------------------------------------

Set notify level 'highlight' on channel "#weechat" only:

----------------------------------------
/set weechat.notify.irc.freenode.#weechat highlight
----------------------------------------

The notify level for a buffer can be set with command `/buffer`:

----------------------------------------
/buffer notify highlight
----------------------------------------

[[key_bindings]]
Default key bindings
~~~~~~~~~~~~~~~~~~~~

// 'C-' = ctrl, 'A-' = alt, 'S-' = shift

[[key_bindings_command_line]]
Keys for command line
^^^^^^^^^^^^^^^^^^^^^

[width="100%",cols="^.^3,.^10,.^5l",options="header"]
|========================================
| Key                 | Description | Command
| @k(←)            .2+| Go to previous char in command line .2+| /input move_previous_char
| @k(C-)@k(b)
| @k(→)            .2+| Go to next char in command line .2+| /input move_next_char
| @k(C-)@k(f)
| @k(C-)@k(←)      .2+| Go to previous word in command line .2+| /input move_previous_word
| @k(A-)@k(b)
| @k(C-)@k(→)      .2+| Go to next word in command line .2+| /input move_next_word
| @k(A-)@k(f)
| @k(Home)         .2+| Go to the beginning of command line .2+| /input move_beginning_of_line
| @k(C-)@k(a)
| @k(End)          .2+| Go to the end of command line .2+| /input move_end_of_line
| @k(C-)@k(e)
| @k(C-)@k(c) , @k(b) | Insert code for bold text | /input insert \x02
| @k(C-)@k(c) , @k(c) | Insert code for colored text | /input insert \x03
| @k(C-)@k(c) , @k(i) | Insert code for italic text | /input insert \x1D
| @k(C-)@k(c) , @k(o) | Insert code for color reset | /input insert \x0F
| @k(C-)@k(c) , @k(r) | Insert code for reverse color | /input insert \x12
| @k(C-)@k(c) , @k(u) | Insert code for underlined text | /input insert \x15
| @k(Del)          .2+| Delete next char in command line .2+| /input delete_next_char
| @k(C-)@k(d)
| @k(Backsp.)      .2+| Delete previous char in command line .2+| /input delete_previous_char
| @k(C-)@k(h)
| @k(C-)@k(k)         | Delete from cursor until end of command line (deleted string is copied to clipboard) | /input delete_end_of_line
| @k(C-)@k(r)         | Search for text in buffer history (see <<key_bindings_search_context,keys for search context>>) | /input search_text
| @k(C-)@k(t)         | Transpose chars | /input transpose_chars
| @k(C-)@k(u)         | Delete from cursor until beginning of command line (deleted string is copied to clipboard) | /input delete_beginning_of_line
| @k(C-)@k(w)         | Delete previous word of command line (deleted string is copied to clipboard) | /input delete_previous_word
| @k(C-)@k(y)         | Paste clipboard content | /input clipboard_paste
| @k(C-)@k(_)         | Undo last action on command line | /input undo
| @k(A-)@k(_)         | Redo last action on command line | /input redo
| @k(Tab)             | Complete command or nick (@k(Tab) again: find next completion) | /input complete_next
| @k(S-)@k(Tab)       | Without completion: do a partial completion, with pending completion: complete with previous completion | /input complete_previous
| @k(Enter)        .3+| Execute command or send message (in search mode: stop search) .3+| /input return
| @k(C-)@k(j)
| @k(C-)@k(m)
| @k(↑)               | Call previous command/message (in search mode: search up) | /input history_previous
| @k(↓)               | Call next command/message (in search mode: search down) | /input history_next
| @k(C-)@k(↑)         | Call previous command/message in global history (common for all buffers) | /input history_global_previous
| @k(C-)@k(↓)         | Call next command/message in global history (common for all buffers) | /input history_global_next
| @k(A-)@k(d)         | Delete next word in command line (deleted string is copied to clipboard) | /input delete_next_word
| @k(A-)@k(k)         | Grab a key and insert its code (and command bound if key exists) in command line | /input grab_key_command
| @k(A-)@k(r)         | Delete entire command line | /input delete_line
| @k(A-)@k(s)         | Toggle aspell | /mute aspell toggle
|========================================

[[key_bindings_buffers_windows]]
Keys for buffers / windows
^^^^^^^^^^^^^^^^^^^^^^^^^^

[width="100%",cols="^.^3,.^10,.^5l",options="header"]
|========================================
| Key                       | Description | Command
| @k(C-)@k(l)               | Redraw whole window | /window refresh
| @k(C-)@k(s) , @k(C-)@k(u) | Set unread marker on all buffers | /input set_unread
| @k(C-)@k(x)               | Switch current buffer if buffers are attached with same number | /input switch_active_buffer
| @k(A-)@k(x)               | Zoom on merged buffer (@k(A-)@k(x) again: display all merged buffers) | /input zoom_merged_buffer
| @k(PgUp)                  | Scroll up one page in buffer history | /window page_up
| @k(PgDn)                  | Scroll down one page in buffer history | /window page_down
| @k(A-)@k(PgUp)            | Scroll up a few lines in buffer history | /window scroll_up
| @k(A-)@k(PgDn)            | Scroll down a few lines in buffer history | /window scroll_down
| @k(A-)@k(Home)            | Scroll to top of buffer | /window scroll_top
| @k(A-)@k(End)             | Scroll to bottom of buffer | /window scroll_bottom
| @k(A-)@k(←)            .4+| Switch to previous buffer .4+| /buffer -1
| @k(A-)@k(↑)
| @k(C-)@k(p)
| @k(F5)
| @k(A-)@k(→)            .4+| Switch to next buffer .4+| /buffer +1
| @k(A-)@k(↓)
| @k(C-)@k(n)
| @k(F6)
| @k(F7)                    | Switch to previous window | /window -1
| @k(F8)                    | Switch to next window | /window +1
| @k(F9)                    | Scroll buffer's title on the left | /bar scroll title * -30%
| @k(F10)                   | Scroll buffer's title on the right | /bar scroll title * +30%
| @k(F11)                   | Scroll up one page in nicklist | /bar scroll nicklist * -100%
| @k(F12)                   | Scroll down one page in nicklist | /bar scroll nicklist * +100%
| @k(A-)@k(F11)             | Go to the beginning of nicklist | /bar scroll nicklist * b
| @k(A-)@k(F12)             | Go to the end of nicklist | /bar scroll nicklist * e
| @k(A-)@k(a)               | Switch to next buffer with activity (with priority: highlight, message, other) | /input jump_smart
| @k(A-)@k(h)               | Clear hotlist (activity notification on other buffers) | /input hotlist_clear
| @k(A-)@k(j) , @k(A-)@k(l) | Switch to last buffer | /input jump_last_buffer
| @k(A-)@k(j) , @k(A-)@k(r) | Switch to IRC raw buffer | /server raw
| @k(A-)@k(j) , @k(A-)@k(s) | Switch to IRC server buffer | /server jump
| @k(A-)@k(0...9)           | Switch to buffer by number (0 = 10) | /buffer *N
| @k(A-)@k(j) , @k(01...99) | Switch to buffer by number | /buffer NN
| @k(A-)@k(m)               | Toggle mouse | /mouse toggle
| @k(A-)@k(n)               | Scroll to next highlight | /window scroll_next_highlight
| @k(A-)@k(p)               | Scroll to previous highlight | /window scroll_previous_highlight
| @k(A-)@k(u)               | Scroll to first unread line in buffer | /window scroll_unread
| @k(A-)@k(w) , @k(A-)@k(↑) | Switch to window above | /window up
| @k(A-)@k(w) , @k(A-)@k(↓) | Switch to window below | /window down
| @k(A-)@k(w) , @k(A-)@k(←) | Switch to window on the left | /window left
| @k(A-)@k(w) , @k(A-)@k(→) | Switch to window on the right | /window right
| @k(A-)@k(w) , @k(A-)@k(b) | Balance the sizes of all windows | /window balance
| @k(A-)@k(w) , @k(A-)@k(s) | Swap buffers of two windows | /window swap
| @k(A-)@k(z)               | Zoom on current window (@k(A-)@k(z) again: restore initial windows state, before zoom) | /window zoom
| @k(A-)@k(<)               | Switch to previous buffer in list of visited buffers | /input jump_previously_visited_buffer
| @k(A-)@k(>)               | Switch to next buffer in list of visited buffers | /input jump_next_visited_buffer
| @k(A-)@k(/)               | Switch to last buffer displayed (before last jump to a buffer) | /input jump_last_buffer_displayed
| @k(A-)@k(=)               | Toggle filters on/off | /filter toggle
|========================================

[[key_bindings_search_context]]
Keys for "search" context
^^^^^^^^^^^^^^^^^^^^^^^^^

These keys are used in context "search" (when @k(C-)@k(r) is pressed to search
text in buffer).

[width="100%",cols="^.^3,.^10,.^5l",options="header"]
|========================================
| Key          | Description | Command
| @k(C-)@k(r)  | Switch exact case for search | /input search_switch_case
| @k(↑)        | Search previous line | /input search_previous
| @k(↓)        | Search next line | /input search_next
| @k(Enter) .3+| Stop search .3+| /input search_stop
| @k(C-)@k(j)
| @k(C-)@k(m)
|========================================

[[key_bindings_cursor_context]]
Keys for "cursor" context
^^^^^^^^^^^^^^^^^^^^^^^^^

These keys are used in context "cursor" (free movement of cursor on screen).

[width="100%",cols="^.^3,^.^3,.^10,.^8l",options="header"]
|========================================
| Key          | Area     | Description | Command
| @k(↑)        | -        | Move cursor one line up | /cursor move up
| @k(↓)        | -        | Move cursor one line down | /cursor move down
| @k(←)        | -        | Move cursor one column left | /cursor move left
| @k(→)        | -        | Move cursor one column right | /cursor move right
| @k(A-)@k(↑)  | -        | Move cursor one area up | /cursor move area_up
| @k(A-)@k(↓)  | -        | Move cursor one area down | /cursor move area_down
| @k(A-)@k(←)  | -        | Move cursor one area left | /cursor move area_left
| @k(A-)@k(→)  | -        | Move cursor one area right | /cursor move area_right
| @k(m)        | chat     | Quote message | hsignal:chat_quote_message;/cursor stop
| @k(q)        | chat     | Quote prefix + message | hsignal:chat_quote_prefix_message;/cursor stop
| @k(Q)        | chat     | Quote time + prefix + message | hsignal:chat_quote_time_prefix_message;/cursor stop
| @k(b)        | nicklist | Ban nick | /window ${_window_number};/ban ${nick}
| @k(k)        | nicklist | Kick nick | /window ${_window_number};/kick ${nick}
| @k(K)        | nicklist | Kick and ban nick | /window ${_window_number};/kickban ${nick}
| @k(q)        | nicklist | Open query with nick | /window ${_window_number};/query ${nick};/cursor stop
| @k(w)        | nicklist | Do a whois on nick | /window ${_window_number};/whois ${nick}
| @k(Enter) .3+| -     .3+| Stop cursor mode .3+| /cursor stop
| @k(C-)@k(j)
| @k(C-)@k(m)
|========================================

[[key_bindings_mouse_context]]
Keys for "mouse" context
^^^^^^^^^^^^^^^^^^^^^^^^

These keys are used in context "mouse", namely when a mouse event occurs.

[width="100%",cols="^.^3,^.^3,^.^3,.^10,.^8l",options="header"]
|========================================
| Button ^(1)^ | Gesture | Area | Description | Command
| ◾◽◽     | -            | chat                 | Switch to window | /window ${_window_number}
| ◾◽◽     | left         | chat                 | Switch to previous buffer | /window ${_window_number};/buffer +1
| ◾◽◽     | right        | chat                 | Switch to next buffer | /window ${_window_number};/buffer +1
| ◾◽◽     | left (long)  | chat                 | Switch to first buffer | /window ${_window_number};/buffer 1
| ◾◽◽     | right (long) | chat                 | Switch to last buffer | /window ${_window_number};/input jump_last_buffer
| ◾◽◽     | -            | chat (script buffer) | Select line in script buffer | /script go ${_chat_line_y}
| ◽◽◾     | -            | chat (script buffer) | Install/remove script | /script go ${_chat_line_y};/script installremove -q ${script_name_with_extension}
| ⇑       | -            | chat                 | Scroll up a few lines in buffer history | /window scroll_up -window ${_window_number}
| ⇓       | -            | chat                 | Scroll down a few lines in buffer history | /window scroll_down -window ${_window_number}
| ⇑       | -            | chat (script buffer) | Move 5 lines up in script buffer | /script up 5
| ⇓       | -            | chat (script buffer) | Move 5 lines down in script buffer | /script down 5
| @k(C-)⇑ | -            | chat                 | Scroll horizontally to the left | /window scroll_horiz -window ${_window_number} -10%
| @k(C-)⇓ | -            | chat                 | Scroll horizontally to the right | /window scroll_horiz -window ${_window_number} +10%
| ◾◽◽     | up           | nicklist             | Scroll up one page in nicklist | /bar scroll nicklist ${_window_number} -100%
| ◾◽◽     | down         | nicklist             | Scroll down one page in nicklist | /bar scroll nicklist ${_window_number} +100%
| ◾◽◽     | up (long)    | nicklist             | Go to the beginning of nicklist | /bar scroll nicklist ${_window_number} b
| ◾◽◽     | down (long)  | nicklist             | Go to the end of nicklist | /bar scroll nicklist ${_window_number} e
| ◾◽◽     | -            | nicklist             | Open query with nick | /window ${_window_number};/query ${nick}
| ◽◽◾     | -            | nicklist             | Do a whois on nick | /window ${_window_number};/whois ${nick}
| ◾◽◽     | left         | nicklist             | Kick nick | /window ${_window_number};/kick ${nick}
| ◾◽◽     | left (long)  | nicklist             | Kick and ban nick | /window ${_window_number};/kickban ${nick}
| ◽◽◾     | left         | nicklist             | Ban nick | /window ${_window_number};/ban ${nick}
| ◽◽◾     | -            | input                | Grab a mouse event and insert its code in command line | /input grab_mouse_area
| ⇑       | -            | any bar              | Scroll bar by -20% | /bar scroll ${_bar_name} ${_window_number} -20%
| ⇓       | -            | any bar              | Scroll bar by +20% | /bar scroll ${_bar_name} ${_window_number} +20%
| ◽◾◽     | -            | anywhere             | Start cursor mode at this point | /cursor go ${_x},${_y}
|========================================

[NOTE]
^(1)^ "⇑" and "⇓" are wheel up and down.

[[mouse]]
Mouse support
~~~~~~~~~~~~~

WeeChat supports mouse clicks and gestures. It is working with local terminal,
and remotely via ssh connection with or without screen/tmux.

[[mouse_enable]]
Enable mouse
^^^^^^^^^^^^

To enable mouse at startup:

----------------------------------------
/set weechat.look.mouse on
----------------------------------------

To enable mouse now, press @k(A-)@k(m) or do following command:

----------------------------------------
/mouse enable
----------------------------------------

It is possible to temporarily disable mouse, and bind that on a key. For example
key @k(A-)@k(x) to disable mouse for 10 seconds:

----------------------------------------
/key bind meta-x /mouse toggle 10
----------------------------------------

When mouse is enabled in WeeChat, you can use @k(-S-) modifier to select or
click in terminal, as if the mouse was disabled (on some terminals like iTerm,
you have to use @k(-A-) instead of @k(-S-)).

[NOTE]
For any problem with mouse, please look at 'WeeChat FAQ'.

[[mouse_bind_events]]
Bind mouse events to commands
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Many default mouse events are already defined by WeeChat (see
<<key_bindings_mouse_context,keys for "mouse" context>>).

You can change or add bindings with the command `/key` using context "mouse"
(for syntax, see <<command_weechat_key,command /key>>).

Event name consists of a modifier (optional), a button/wheel name and a gesture
(optional). Different elements are separated by "-".

List of modifiers:

[width="50%",cols="3m,4",options="header"]
|========================================
| Modifier | Description
| ctrl     | key @k(-C-)
| alt      | key @k(-A-)
| ctrl-alt | keys @k(-C-) and @k(-A-)
|========================================

List of buttons/wheel:

[width="50%",cols="3m,4",options="header"]
|========================================
| Button/wheel        | Description
| button1             | click on left button
| button2             | click on right button
| button3             | click on middle button (often click on wheel)
| button4 ... button9 | click on extra buttons
| wheelup             | wheel (up)
| wheeldown           | wheel (down)
|========================================

List of gestures (only for buttons, not wheel):

[width="50%",cols="3m,4",options="header"]
|========================================
| Gesture            | Distance
| gesture-up         | 3 ... 19
| gesture-up-long    | ≥ 20
| gesture-down       | 3 ... 19
| gesture-down-long  | ≥ 20
| gesture-left       | 3 ... 39
| gesture-left-long  | ≥ 40
| gesture-right      | 3 ... 39
| gesture-right-long | ≥ 40
|========================================

List of incomplete events (only for buttons, useful for plugins/scripts):

[width="50%",cols="3m,4",options="header"]
|========================================
| Event      | Description
| event-down | button was pressed but not released yet
| event-drag | mouse was moved with button pressed down
|========================================

Example of events:

* `button1`
* `ctrl-button1`
* `button1-gesture-right`
* `button1-event-down`
* `button1-event-drag`
* `alt-button2-gesture-down-long`
* `wheelup`
* `ctrl-alt-wheeldown`
* ...

[TIP]
When binding a key in context "mouse", it's possible to match many events using
`*` at beginning or end of name, for example `button1-gesture-*` will match any
gesture made using left button.

[TIP]
You can find an event name with command `/input grab_mouse` then doing event
with mouse. This will insert event name on command line.

[[command_line]]
Command line
~~~~~~~~~~~~

WeeChat command line (at the bottom of window) lets you execute commands or
send text to buffer.

[[command_line_syntax]]
Syntax
^^^^^^

Commands begin with "/" char, followed by name of command. For example, to see
list of all options:

----------------------------------------
/set
----------------------------------------

Text sent to a buffer is any text that does not begin with "/" char.
For example, to send text 'hello' on current buffer:

----------------------------------------
hello
----------------------------------------

However, it is possible to start with "/" char, by adding another.
For example, to send text '/set' on current buffer:

----------------------------------------
//set
----------------------------------------

[[command_line_colors]]
Color codes
^^^^^^^^^^^

For some plugins like IRC, you can use color codes and attributes, as
follow (press @k(C-)@k(c) then following letter, with optional value):

@k(C-)@k(c) , @k(b)::
    bold text

@k(C-)@k(c) , @k(c) , @k(xx)::
    text color `xx` (see list of colors below)

@k(C-)@k(c) , @k(c) , @k(xx,yy)::
    text color `xx` and background `yy` (see list of colors below)

@k(C-)@k(c) , @k(o)::
    disable color and attributes

@k(C-)@k(c) , @k(r)::
    reverse video (revert text color with background)

@k(C-)@k(c) , @k(u)::
    underlined text

[NOTE]
The same code (without number for @k(C-)@k(c) , @k(c)) may be used to stop the
attribute.

Color codes for @k(C-)@k(c) , @k(c) are:

[width="50%",cols="^1m,3,3",options="header"]
|========================================
| Code | IRC           | WeeChat (curses)
| 00   | white         | white
| 01   | black         | black
| 02   | dark blue     | blue
| 03   | dark green    | green
| 04   | light red     | lightred
| 05   | dark red      | red
| 06   | magenta       | magenta
| 07   | orange        | brown
| 08   | yellow        | yellow
| 09   | light green   | lightgreen
| 10   | cyan          | cyan
| 11   | light cyan    | lightcyan
| 12   | light blue    | lightblue
| 13   | light magenta | lightmagenta
| 14   | gray          | gray
| 15   | light gray    | white
|========================================

Example: display of "hello everybody!" with "hello" in light blue bold and
"everybody" in light red underlined:

----------------------------------------
^Cc12^Cbhello ^Cb^Cc04^Cueverybody^Cu^Cc!
----------------------------------------

[NOTE]
In irc plugin, you can remap these colors using option
<<option_irc.color.mirc_remap,irc.color.mirc_remap>>.

[[colors]]
Colors
~~~~~~

WeeChat can use up to 256 color pairs to display text in bars and chat area
(your terminal must support 256 colors to use them in WeeChat).

According to value of 'TERM' environment variable, you may have following limits
for colors in WeeChat:

[width="50%",cols="8,>2,>2",options="header"]
|========================================
| $TERM                                 | Colors | Pairs ^(1)^
| "rxvt-unicode", "xterm",...           |     88 |         256
| "rxvt-256color", "xterm-256color",... |    256 |       32767
| "screen"                              |      8 |          64
| "screen-256color"                     |    256 |       32767
|========================================

[NOTE]
^(1)^ Even if your terminal supports more than 256 pairs, only 256 pairs can be
used in WeeChat, because of a ncurses limitation.

You can run `weechat-curses --colors` or use command `/color` in WeeChat to
display limits for your environment.

Some recommended values for 'TERM' if you want 256 colors:

* under screen: 'screen-256color'
* outside screen: 'xterm-256color', 'rxvt-256color', 'putty-256color',...

[NOTE]
You may have to install package "ncurses-term" to use these values in 'TERM'
variable.

If you are using screen, you can add this line to your '~/.screenrc':

----------------------------------------
term screen-256color
----------------------------------------

If your 'TERM' variable has wrong value and that WeeChat is already running,
don't panic! You can change it without restarting, thanks to script 'shell.py':

----------------------------------------
/shell setenv TERM=screen-256color
/upgrade
----------------------------------------

[[colors_basic]]
Basic colors
^^^^^^^^^^^^

Basic colors in WeeChat are:

[width="50%",cols="^3m,8",options="header"]
|========================================
| Name         | Color
| default      | default terminal color (transparent for background)
| black        | black
| darkgray     | dark gray
| red          | dark red
| lightred     | light red
| green        | dark green
| lightgreen   | light green
| brown        | brown
| yellow       | yellow
| blue         | dark blue
| lightblue    | light blue
| magenta      | dark magenta
| lightmagenta | light magenta
| cyan         | dark cyan
| lightcyan    | light cyan
| gray         | gray
| white        | white
|========================================

[[colors_extended]]
Extended colors
^^^^^^^^^^^^^^^

WeeChat dynamically allocates color pairs when colors are used on screen (to
display buffers and bars).

In addition to basic colors, you can use a color number between 1 and the limit
of your terminal.

Use command `/color` to see current colors and limits. With @k(A-)@k(c) you can
temporarily switch to terminal colors to choose a color.

For example if you want to display time in orange in buffer, do:

----------------------------------------
/set weechat.color.chat_time 214
----------------------------------------

Or if you want a very dark green background for status bar:

----------------------------------------
/set weechat.bar.status.color_bg 22
----------------------------------------

[[colors_aliases]]
Aliases
^^^^^^^

You can add color aliases with command `/color alias` and then use this alias
in any color option.

For example:

----------------------------------------
/color alias 214 orange
/set weechat.color.chat_delimiters orange
----------------------------------------

[[colors_attributes]]
Attributes
^^^^^^^^^^

It is possible to use some attributes for colors. One or more attributes can be
added before color name or number:

* `*` : bold text
* `!` : reverse video
* `_` : underlined text
* `|` : keep attributes: do not reset bold/reverse/underlined when changing
  color

For example if you want self nick as white underlined, do:

----------------------------------------
/set weechat.color.chat_nick_self _white
----------------------------------------

Or if you want time in status bar as orange underlined with bold:

----------------------------------------
/set weechat.color.status_time *_214
----------------------------------------

To use an attribute with default terminal color (-1), you must use a number
greater than last terminal color, for example max color in WeeChat: 99999.

Example of bold with terminal foreground color:

----------------------------------------
/set weechat.color.status_time *99999
----------------------------------------

[[weechat_options]]
WeeChat options (weechat.conf)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

include::autogen/user/weechat_options.txt[]

[[weechat_commands]]
WeeChat commands
~~~~~~~~~~~~~~~~

include::autogen/user/weechat_commands.txt[]

[[plugins]]
Plugins
-------

To learn more about plugin or script development (through API), please read
'WeeChat Plugin API Reference' or 'WeeChat Scripting Guide'.

[[plugins_in_weechat]]
Plugins in WeeChat
~~~~~~~~~~~~~~~~~~

A plugin is a dynamic library, written in C and compiled, which is loaded by
WeeChat.
Under GNU/Linux, the file has ".so" extension, ".dll" under Windows.

Plugins found are automatically loaded when WeeChat is starting, and it is
possible to load or unload plugins while WeeChat is running.

It's important to make difference between a 'plugin' and a 'script': a
'plugin' is a binary file compiled and loaded with command `/plugin`, whereas
a 'script' is a text file loaded with a plugin like 'python' with command
`/python`.

You can use command `/plugin` to load/unload a plugin, or list all loaded
plugins.
When a plugin is unloaded, all buffers created by this plugin are
automatically closed.

Examples to load, unload or list plugins:

----------------------------------------
/plugin load irc
/plugin unload irc
/plugin list
----------------------------------------

Default plugins are:

[width="50%",cols="^1,5",options="header"]
|========================================
| Plugin    | Description
| alias     | Define alias for commands
| aspell    | Spell checking for command line
| charset   | Charset decoding/encoding for buffers
| demo      | Demo plugin (not compiled by default)
| fifo      | FIFO pipe used to remotely send commands to WeeChat
| irc       | IRC chat protocol
| logger    | Log buffers to files
| relay     | Relay data via network (IRC proxy)
| rmodifier | Alter modifier strings with regular expressions
| python    | Python scripting API
| perl      | Perl scripting API
| ruby      | Ruby scripting API
| lua       | Lua scripting API
| tcl       | Tcl scripting API
| guile     | Guile (scheme) scripting API
| xfer      | File transfer and direct chat
|========================================

[[alias_plugin]]
Alias plugin
~~~~~~~~~~~~

Alias plugin lets you create alias for commands (from WeeChat or other
plugins).

[[alias_commands]]
Commands
^^^^^^^^

include::autogen/user/alias_commands.txt[]

[[aspell_plugin]]
Aspell plugin
~~~~~~~~~~~~

Aspell plugin lets you check spelling in command line. It is possible to use
many languages by buffer.

[[aspell_options]]
Options (aspell.conf)
^^^^^^^^^^^^^^^^^^^^^

include::autogen/user/aspell_options.txt[]

[[aspell_commands]]
Commands
^^^^^^^^

include::autogen/user/aspell_commands.txt[]

[[aspell_speller_options]]
Speller options
^^^^^^^^^^^^^^^

Speller options can be defined by adding options in section "option" of aspell
configuration.

The option name is an aspell configuration option. List of options can be found
in a shell with following command:

----------------------------------------
$ aspell config
----------------------------------------

For example, to enable option "ignore-case":

----------------------------------------
/set aspell.option.ignore-case "true"
----------------------------------------

[[aspell_suggestions]]
Suggestions
^^^^^^^^^^^

Suggestions are displayed in a bar item called "aspell_suggest". The number of
suggestions is set in option 'aspell.check.suggestions'.

To enable suggestions you must set option 'aspell.check.suggestions' to an
integer ≥ 0 and add the bar item "aspell_suggest" to a bar, like 'status'.

Example of suggestions with English dictionary (`en`):

........................................
│[12:55] [6] [irc/freenode] 3:#test(+n){4} [print,prone,prune]                    │
│[@Flashy] prinr █                                                                │
└─────────────────────────────────────────────────────────────────────────────────┘
........................................

Example of suggestions with English and French dictionaries (`en,fr`):

........................................
│[12:55] [6] [irc/freenode] 3:#test(+n){4} [print,prone,prune/prime,primer,primé] │
│[@Flashy] prinr █                                                                │
└─────────────────────────────────────────────────────────────────────────────────┘
........................................

[[charset_plugin]]
Charset plugin
~~~~~~~~~~~~~~

Charset plugin lets you decode or encode data using charsets.

There is default charset for decode/encode, and specific charsets for buffers
(or group of buffers).

This plugin is optional, but recommended: if it's not loaded, WeeChat
can only read/write UTF-8 data.

Charset plugin should be autoloaded by WeeChat. To be sure plugin is loaded,
try:

----------------------------------------
/charset
----------------------------------------

If command is not found, then load plugin with command:

----------------------------------------
/plugin load charset
----------------------------------------

If plugin is not found, then you should compile again WeeChat with
plugins and Charset support.

When Charset plugin starts, it displays terminal and internal charsets.
Terminal charset depends on your locale, and internal is UTF-8.

For example:

........................................
charset: terminal: ISO-8859-15, internal: UTF-8
........................................

[[charset_options]]
Options (charset.conf)
^^^^^^^^^^^^^^^^^^^^^^

include::autogen/user/charset_options.txt[]

[[charset_commands]]
Commands
^^^^^^^^

include::autogen/user/charset_commands.txt[]

[[charset_set]]
Set charset
^^^^^^^^^^^

To set global decode and encode charsets, use command `/set`.

For example:

----------------------------------------
/set charset.default.decode ISO-8859-15
/set charset.default.encode ISO-8859-15
----------------------------------------

If global decode charset is not set (for example during first
load of Charset plugin), it will be automatically set to terminal
charset (if it's different from UTF-8), or by default to 'ISO-8859-1'.

Default encode value is empty, so it sends by default with
internal charset (UTF-8).

To set IRC server charset, use command `/charset` on server buffer.
If you give only charset, then it will set decoding and encoding values.

For example:

----------------------------------------
/charset ISO-8859-15
----------------------------------------

It's equivalent to:

----------------------------------------
/charset decode ISO-8859-15
/charset encode ISO-8859-15
----------------------------------------

To set IRC channel (or private) charset, use same commands as server,
but on channel (or private) buffer.

To see all charsets used, use following command:

----------------------------------------
/set charset.*
----------------------------------------

[[charset_troubleshooting]]
Troubleshooting
^^^^^^^^^^^^^^^

For any problem with charsets, please look at 'WeeChat FAQ'.

[[fifo_plugin]]
Fifo plugin
~~~~~~~~~~~

You can remote control WeeChat, by sending commands or text to a FIFO pipe (if
option "plugins.var.fifo.fifo" is enabled, it is by default).

The FIFO pipe is located in '~/.weechat/' and is called 'weechat_fifo_xxxx'
(where 'xxxx' is the process ID (PID) of running WeeChat).

Syntax for the FIFO pipe commands/text is one of following:

........................................
  plugin.buffer *text or command here
  *text or command here
........................................

Some examples:

* nick change on IRC server freenode to "newnick":

----------------------------------------
$ echo 'irc.server.freenode */nick newnick' >~/.weechat/weechat_fifo_12345
----------------------------------------

* display text on IRC #weechat channel:

----------------------------------------
$ echo 'irc.freenode.#weechat *hello!' >~/.weechat/weechat_fifo_12345
----------------------------------------

* display text on current buffer:

----------------------------------------
$ echo '*hello!' >~/.weechat/weechat_fifo_12345
----------------------------------------

* send two commands to unload/reload Python scripts (you have to separate them
  with "\n"):

----------------------------------------
$ echo -e '*/python unload\n*/python autoload' >~/.weechat/weechat_fifo_12345
----------------------------------------

You can write a script to send command to all running WeeChat at same time,
for example:

[source,shell]
----------------------------------------
#!/bin/sh
if [ $# -eq 1 ]; then
    for fifo in ~/.weechat/weechat_fifo_*
    do
        echo -e "$1" >$fifo
    done
fi
----------------------------------------

If the script is called "auto_weechat_command", you can run it with:

----------------------------------------
$ ./auto_weechat_command 'irc.freenode.#weechat *hello'
----------------------------------------

[[irc_plugin]]
IRC plugin
~~~~~~~~~~

The IRC plugin is designed to chat through IRC protocol with other people.

It is multi-servers, and offers all supported IRC commands including DCC chat
and file transfer (via xfer plugin, see <<xfer_plugin,Xfer plugin>>).

[[irc_command_line_options]]
Command line options
^^^^^^^^^^^^^^^^^^^^

It is possible to give URL for one or many IRC servers, as follow:

----------------------------------------
irc[6][s]://[nick[:password]@]irc.example.org[:port][/channel][,channel[...]]
----------------------------------------

Example to join '#weechat' and '#toto' on server 'irc.freenode.net' server,
default port (6667), with nick 'nono':

----------------------------------------
$ weechat-curses irc://nono@irc.freenode.net/#weechat,#toto
----------------------------------------

[[irc_options]]
Options (irc.conf)
^^^^^^^^^^^^^^^^^^

include::autogen/user/irc_options.txt[]

[[irc_commands]]
Commands
^^^^^^^^

include::autogen/user/irc_commands.txt[]

[[irc_ssl_certificates]]
SSL certificates
^^^^^^^^^^^^^^^^

When connecting to IRC server with SSL, WeeChat checks by default that the
connection is fully trusted.

Some options are used to control SSL connection:

weechat.network.gnutls_ca_file::
    path to file with certificate authorities (by default: "%h/ssl/CAs.pem")

irc.server.xxx.ssl_cert::
    SSL certificate file used to automatically identify your nick (for example
    CertFP on oftc, see below)

irc.server.xxx.ssl_dhkey_size::
    size of the key used during the Diffie-Hellman Key Exchange (by default:
    2048)

irc.server.xxx.ssl_verify::
    check that the SSL connection is fully trusted (on by default)

[NOTE]
Option "ssl_verify" is on by default, so verification is strict and may fail,
even if it was OK with versions prior to 0.3.1.

[[irc_connect_oftc_with_certificate]]
First example: connect to oftc and check certificate
++++++++++++++++++++++++++++++++++++++++++++++++++++

* Import certificate in shell:

----------------------------------------
$ mkdir -p ~/.weechat/ssl
$ wget -O ~/.weechat/ssl/CAs.pem http://www.spi-inc.org/ca/spi-cacert.crt
----------------------------------------

Note: it is possible to concatenate many certificates in file CAs.pem.

* In WeeChat, with "oftc" server already created:

----------------------------------------
/connect oftc
----------------------------------------

[[irc_connect_oftc_with_certfp]]
Second example: connect to oftc using CertFP
++++++++++++++++++++++++++++++++++++++++++++

* Create certificate in shell:

----------------------------------------
$ mkdir -p ~/.weechat/ssl
$ cd ~/.weechat/ssl
$ openssl req -nodes -newkey rsa:2048 -keyout nick.pem -x509 -days 365 -out nick.pem
----------------------------------------

* In WeeChat, with "oftc" server already created:

----------------------------------------
/set irc.server.oftc.ssl_cert "%h/ssl/nick.pem"
/connect oftc
/msg nickserv cert add
----------------------------------------

For more information, look at http://www.oftc.net/oftc/NickServ/CertFP

[[irc_sasl_authentication]]
SASL authentication
^^^^^^^^^^^^^^^^^^^

WeeChat supports SASL authentication, using three mechanisms: "plain" (plain
text password), "dh-blowfish" (encrypted password) or "external" (client side
SSL cert).

Options in servers are:

* 'sasl_mechanism': mechanism to use ("plain", "dh-blowfish" or "external")
* 'sasl_timeout': timeout (in seconds) for authentication
* 'sasl_username': username (nick)
* 'sasl_password': password

If you want to use "dh-blowfish" by default for all servers:

----------------------------------------
/set irc.server_default.sasl_mechanism dh-blowfish
----------------------------------------

[NOTE]
The "gcrypt" library is required when compiling WeeChat in order to use
"dh-blowfish" mechanism (see <<dependencies,dependencies>>).

[[irc_tor_freenode]]
Connect to Freenode with TOR/SASL
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

In addition to SSL, Freenode servers support connections with TOR
(https://www.torproject.org/), a network of virtual tunnels that allows people
and groups to improve their privacy and security on the Internet.

First, make sure to have WeeChat compiled with <<dependencies,libgcrypt11-dev>>
(if built from sources); it's not mandatory, but "dh-blowfish" ensures stronger
security compared to "plain" authentication system with SASL.

In first place, install TOR. For Debian (and derived):

----------------------------------------
$ sudo apt-get install tor
----------------------------------------

In WeeChat you need to create a socks5 proxy for TOR service (hostname/IP and
port depend on your TOR configuration):

----------------------------------------
/proxy add tor socks5 127.0.0.1 9050
----------------------------------------

Now, create a new server, for example:

----------------------------------------
/server add freenode-tor p4fsi4ockecnea7l.onion
----------------------------------------

Set proxy for TOR:

----------------------------------------
/set irc.server.freenode-tor.proxy "tor"
----------------------------------------

Set SASL authentication:

----------------------------------------
/set irc.server.freenode-tor.sasl_mechanism dh-blowfish
/set irc.server.freenode-tor.sasl_username "your_nickname"
/set irc.server.freenode-tor.sasl_password "your_password"
----------------------------------------

And finally, connection to server:

----------------------------------------
/connect freenode-tor
----------------------------------------

For more info about Freenode and TOR: http://freenode.net/irc_servers.shtml#tor

[[irc_smart_filter_join_part_quit]]
Smart filter for join/part/quit messages
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

A smart filter is available to filter join/part/quit messages when nick did not
say something during past X minutes on channel.

Smart filter is enabled by default, but you must add a filter to hide lines on
buffers, for example:

----------------------------------------
/filter add irc_smart * irc_smart_filter *
----------------------------------------

It is possible to create filter for one channel only or channels beginning with
same name (see `/help filter`):

----------------------------------------
/filter add irc_smart_weechat irc.freenode.#weechat irc_smart_filter *
/filter add irc_smart_weechats irc.freenode.#weechat* irc_smart_filter *
----------------------------------------

You can hide only join or part/quit with following options:

----------------------------------------
/set irc.look.smart_filter_join on
/set irc.look.smart_filter_quit on
----------------------------------------

You can setup delay (in minutes):

----------------------------------------
/set irc.look.smart_filter_delay 5
----------------------------------------

If a nick did not speak during last 5 minutes, its join and/or part/quit will be
hidden on channel.

[[irc_ctcp_replies]]
CTCP replies
^^^^^^^^^^^^

It is possible to customize CTCP replies, or block some CTCP queries (do not
reply).

For example, to customize reply to CTCP "VERSION", use following command:

----------------------------------------
/set irc.ctcp.version "I'm running WeeChat $version, it rocks!"
----------------------------------------

If you want to block CTCP "VERSION" (do not reply to a query), then set empty
string:

----------------------------------------
/set irc.ctcp.version ""
----------------------------------------

Even unknown CTCP can be customized, for example you can reply to
CTCP "BLABLA":

----------------------------------------
/set irc.ctcp.blabla "This is my answer to CTCP BLABLA"
----------------------------------------

It is possible to customize CTCP for one server only, using its internal name
before CTCP name:

----------------------------------------
/set irc.ctcp.freenode.version "WeeChat $version (for freenode)"
----------------------------------------

If you want to restore standard CTCP reply, then remove option:

----------------------------------------
/unset irc.ctcp.version
----------------------------------------

Following codes can be used in strings and are automatically expanded by WeeChat
when replying to CTCP:

[width="100%",cols="^2l,4,8l",options="header"]
|========================================
| Code         | Description                   | Value/example
| $clientinfo  | list of supported CTCP        | ACTION DCC CLIENTINFO FINGER PING SOURCE TIME USERINFO VERSION
| $version     | WeeChat version               | 0.4.0-dev
| $versiongit  | WeeChat version + git version | 0.4.0-dev (git: v0.3.9-104-g7eb5cc4)
| $git         | git version                   | v0.3.9-104-g7eb5cc4
| $compilation | WeeChat compilation date      | Dec 16 2012
| $osinfo      | info about OS                 | Linux 2.6.32-5-amd64 / x86_64
| $site        | WeeChat site                  | http://www.weechat.org/
| $download    | WeeChat site, download page   | http://www.weechat.org/download
| $time        | current date/time             | Sun, 16 Dec 2012 10:40:48 +0100
| $username    | user name on IRC server       | name
| $realname    | real name on IRC server       | John Doe
|========================================

[NOTE]
The git version is the output of command `git describe`. It is known only if
WeeChat has been compiled inside the git repository and if git was installed.

If CTCP options are not defined (by default), CTCP replies are:

[width="100%",cols="^2,4l,8l",options="header"]
|========================================
| CTCP       | Reply format                       | Example
| CLIENTINFO | $clientinfo                        | ACTION DCC CLIENTINFO FINGER PING SOURCE TIME USERINFO VERSION
| FINGER     | WeeChat $versiongit                | WeeChat 0.4.0-dev (git: v0.3.9-104-g7eb5cc4)
| SOURCE     | $download                          | http://www.weechat.org/download
| TIME       | $time                              | Sun, 16 Dec 2012 10:40:48 +0100
| USERINFO   | $username ($realname)              | name (John Doe)
| VERSION    | WeeChat $versiongit ($compilation) | WeeChat 0.4.0-dev (git: v0.3.9-104-g7eb5cc4) (Dec 16 2012)
|========================================

[[irc_target_buffer]]
Target buffer for IRC messages
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

It is possible to customize target buffer for IRC messages (buffer used to
display message) with options `irc.msgbuffer.*`.

For some IRC messages (see list below), you can use value:

current::
    current buffer (if it's IRC buffer, or on server buffer by default)

private::
    private buffer for nick, or current/server buffer if not found (according
    to option 'irc.look.msgbuffer_fallback')

server::
    server buffer

weechat::
    WeeChat "core" buffer

When option is not set (default), WeeChat chooses appropriate buffer, commonly
server or channel buffer.

Non-comprehensive list of IRC messages or alias that you can customize:

[width="60%",cols="^1m,^3m,8",options="header"]
|========================================
| message | alias         | description
| error   |               | error
| invite  |               | invited on a channel
| join    |               | join
| kick    |               | kick
| kill    |               | kill
| mode    |               | mode
| notice  |               | notice
| part    |               | part
| quit    |               | quit
| topic   |               | topic
| wallops |               | wallops
|         | ctcp          | ctcp (sent or received, in a privmsg or notice message)
| 221     |               | user mode string
| 275     | whois         | whois (secure connection)
| 301     | whois         | whois (away)
| 303     |               | ison
| 305     | unaway        | unaway
| 306     | away          | away
| 307     | whois         | whois (registered nick)
| 310     | whois         | whois (help mode)
| 311     | whois         | whois (user)
| 312     | whois         | whois (server)
| 313     | whois         | whois (operator)
| 314     | whowas        | whowas
| 315     | who           | who (end)
| 317     | whois         | whois (idle)
| 318     | whois         | whois (end)
| 319     | whois         | whois (channels)
| 320     | whois         | whois (identified user)
| 321     | list          | list (start)
| 322     | list          | list (channel)
| 323     | list          | list (end)
| 326     | whois         | whois (has oper privs)
| 327     | whois         | whois (host)
| 328     |               | channel URL
| 329     |               | channel creation date
| 330     | whois         | whois (logged in as)
| 331     |               | no topic for channel
| 332     |               | topic of channel
| 333     |               | infos about topic
| 335     | whois         | whois (is a bot on)
| 338     | whois         | whois (host)
| 341     |               | inviting
| 343     | whois         | whois (is opered as)
| 344     | reop          | channel reop
| 345     | reop          | channel reop (end)
| 346     | invitelist    | invite list
| 347     | invitelist    | invite list (end)
| 348     | exceptionlist | exception list
| 349     | exceptionlist | exception list (end)
| 351     |               | server version
| 352     | who           | who
| 353     | names         | list of users on channel
| 366     | names         | end of /names list
| 367     | banlist       | ban list
| 368     | banlist       | end of ban list
| 369     | whowas        | whowas (end)
| 378     | whois         | whois (connecting from)
| 379     | whois         | whois (using modes)
| 432     |               | erroneous nickname
| 433     |               | nickname already in use
| 438     |               | not authorized to change nickname
| 671     | whois         | whois (secure connection)
| 728     | quietlist     | quiet list
| 729     | quietlist     | end of quiet list
| 901     |               | you are now logged in
|========================================

Other numeric commands can be customized as well.

Message can be prefixed by server name to be specific to an irc server
(for example: `freenode.whois`).

Some examples:

* display result of `/whois` on private buffer:

----------------------------------------
/set irc.msgbuffer.whois private
----------------------------------------

* restore default buffer for whois (server buffer):

----------------------------------------
/unset irc.msgbuffer.whois
----------------------------------------

* display invitation on current buffer, only for "freenode" server:

----------------------------------------
/set irc.msgbuffer.freenode.invite current
----------------------------------------

* display message "303" (ison) on WeeChat "core" buffer:

----------------------------------------
/set irc.msgbuffer.303 weechat
----------------------------------------

[[logger_plugin]]
Logger plugin
~~~~~~~~~~~~~

The Logger plugin lets you save content of buffers to files, with options
about what and how it is saved.

[[logger_options]]
Options (logger.conf)
^^^^^^^^^^^^^^^^^^^^^

include::autogen/user/logger_options.txt[]

[[logger_commands]]
Commands
^^^^^^^^

include::autogen/user/logger_commands.txt[]

[[logger_log_levels]]
Log levels
^^^^^^^^^^

Logging is made with a level for each buffer. Default level is 9 (log
all messages displayed on buffer).
You can change level for one buffer, or a group of buffers.

Possible levels are 0 to 9. Zero means "do not log anything" and 9 means
"log all messages".

Plugins are using different levels for messages displayed.
IRC plugin uses following levels:

* level 1: message from user (on channel or private)
* level 2: nick change (you or someone else)
* level 3: any server message (except join/part/quit)
* level 4: server message join/part/quit

So if you set level 3 for an IRC channel, WeeChat will log all messages,
but not join/part/quit.

Some examples:

* set level 3 for IRC channel #weechat:

----------------------------------------
/set logger.level.irc.freenode.#weechat 3
----------------------------------------

* set level 3 for freenode server buffer:

----------------------------------------
/set logger.level.irc.server.freenode 3
----------------------------------------

* set level 3 for all channels on server freenode:

----------------------------------------
/set logger.level.irc.freenode 3
----------------------------------------

* set level 2 for all IRC buffers:

----------------------------------------
/set logger.level.irc 2
----------------------------------------

[[logger_filenames_masks]]
Filenames masks
^^^^^^^^^^^^^^^

It is possible to define a filename mask for each buffer, and use local buffer
variables to build filename. To see local variables for current buffer:

----------------------------------------
/buffer localvar
----------------------------------------

For example, on buffer "irc.freenode.#weechat", WeeChat will search a mask with
option name, in this order:

----------------------------------------
logger.mask.irc.freenode.#weechat
logger.mask.irc.freenode
logger.mask.irc
logger.file.mask
----------------------------------------

That means you can have masks specific for some IRC servers
("logger.mask.irc.freenode") or for a plugin ("logger.mask.irc").

[[logger_files_by_date]]
Log files by date
+++++++++++++++++

To have log files by date, you can use date/time specifiers in mask (see
`man strftime` for formats), for example:

----------------------------------------
/set logger.file.mask "%Y/%m/$plugin.$name.weechatlog"
----------------------------------------

You'll have following files:

........................................
~/.weechat/
    |--- logs/
        |--- 2010/
            |--- 11/
            |       irc.server.freenode.weechatlog
            |       irc.freenode.#weechat.weechatlog
        |--- 2010/
            |--- 12/
            |       irc.server.freenode.weechatlog
            |       irc.freenode.#weechat.weechatlog
........................................

[[logger_irc_files_by_server_channel]]
IRC log files by server and channel
+++++++++++++++++++++++++++++++++++

If you want one directory by IRC server and one file by channel inside:

----------------------------------------
/set logger.mask.irc "irc/$server/$channel.weechatlog"
----------------------------------------

You'll have following files:

........................................
~/.weechat/
    |--- logs/
        |--- irc/
            |--- freenode/
            |       freenode.weechatlog
            |       #weechat.weechatlog
            |       #mychan.weechatlog
            |--- oftc/
            |       oftc.weechatlog
            |       #chan1.weechatlog
            |       #chan2.weechatlog
........................................

[[relay_plugin]]
Relay plugin
~~~~~~~~~~~~

The Relay plugin is used to relay data via network, using different protocols:

* 'irc': IRC proxy: used to share connections to IRC servers with one or many
  other IRC clients
* 'weechat': protocol used by remote interfaces to display and interact with
  WeeChat (for example QWeeChat)

[[relay_options]]
Options (relay.conf)
^^^^^^^^^^^^^^^^^^^^

include::autogen/user/relay_options.txt[]

[[relay_commands]]
Commands
^^^^^^^^

include::autogen/user/relay_commands.txt[]

[[relay_irc_proxy]]
IRC proxy
^^^^^^^^^

The Relay plugin can act as an IRC proxy: you can define one port by IRC server
and use a password for clients.

For example:

----------------------------------------
/set relay.network.password "mypass"
/relay add irc.freenode 8000
----------------------------------------

Now you can connect on port 8000 with any IRC client (WeeChat, xchat,
irssi, ..), using server password "mypass".

You can limit number of allowed clients:

----------------------------------------
/set relay.network.max_clients 1
----------------------------------------

[[relay_weechat_protocol]]
WeeChat protocol
^^^^^^^^^^^^^^^^

The Relay plugin can send data to remote interface using WeeChat protocol.

For example:

----------------------------------------
/set relay.network.password "mypass"
/relay add weechat 9000
----------------------------------------

Now you can connect on port 9000 with a remote interface (like QWeeChat),
using password "mypass".

[[relay_ssl]]
Relay with SSL
^^^^^^^^^^^^^^

You can use SSL by creating a certificate and private key, and by using prefix
"ssl." in the name of protocol.

The default file for certificate/key is '~/.weechat/ssl/relay.pem'
(option <<option_relay.network.ssl_cert_key,relay.network.ssl_cert_key>>).

You can create a certificate and private key with following commands:

----------------------------------------
$ mkdir -p ~/.weechat/ssl
$ cd ~/.weechat/ssl
$ openssl req -nodes -newkey rsa:2048 -keyout relay.pem -x509 -days 365 -out relay.pem
----------------------------------------

If WeeChat is already running, you can reload the certificate and private key
with command:

----------------------------------------
/relay sslcertkey
----------------------------------------

And then add relay with SSL, for example:

----------------------------------------
/relay add ssl.irc.freenode 8001
/relay add ssl.weechat 9001
----------------------------------------

[[relay_websocket]]
Websocket
^^^^^^^^^

WebSocket protocol (http://tools.ietf.org/html/rfc6455[RFC 6455]) is supported
in Relay plugin for all protocols.

The WebSocket handshake is automatically detected and socket becomes ready for
WebSocket if required headers are found in handshake and if origin is allowed
(see option
<<option_relay.network.websocket_allowed_origins,relay.network.websocket_allowed_origins>>).

A WebSocket can be opened in a HTML5 with a single line of JavaScript:

[source,js]
----------------------------------------
websocket = new WebSocket("ws://server.com:5000/weechat");
----------------------------------------

The port (5000 in example) is the port defined in Relay plugin.
The URI must always ends with "/weechat" (for both IRC and WeeChat protocols).

[[rmodifier_plugin]]
Rmodifier plugin
~~~~~~~~~~~~~~~~

The Rmodifier plugin lets you alter modifier strings using regular expressions.
Typical use is to hide password when you type them, or when WeeChat saves
them in command history. For example, it is possible to replace each char in
these passwords by `*`.

[[rmodifier_options]]
Options (rmodifier.conf)
^^^^^^^^^^^^^^^^^^^^^^^^

include::autogen/user/rmodifier_options.txt[]

[[rmodifier_commands]]
Commands
^^^^^^^^

include::autogen/user/rmodifier_commands.txt[]

[[rmodifier_creation]]
Rmodifier creation
^^^^^^^^^^^^^^^^^^

A rmodifier consists of three elements:

. one or more "modifiers"
. a regular expression, to capture "groups"
. a string that describes output using number of "groups" captured in regular
  expression

For list of modifiers used by WeeChat or plugins, see
'WeeChat Plugin API Reference', function 'weechat_hook_modifier'.

For each captured group, following actions are possible:

* keep group as-is (by using group number)
* replace all chars in group to hide content (group number + `*`)
* remove group (if group is not used in string)

Example of default rmodifier for command `/oper`:

* modifiers: `history_add,input_text_display`
** `history_add`: called when WeeChat stores command in history
** `input_text_display`: called when command line has changed
   (applies only on display, not content of command line)
* regular expression: `^(/oper +\S+ +)(.*)`
* groups: `1,2*`

Each time modifiers "history_add" or "input_text_display" are called, regular
expression is checked. If string matches, then it is replaced by captured groups,
as defined in string with groups.

In this example, we keep number 1 as-is, and we replace all chars of group 2 by
replacement char defined in configuration (option 'rmodifier.look.hide_char').

If command line contains: `/oper nick password` then display becomes:
`/oper nick ********`.

[[scripts_plugins]]
Scripts plugins
~~~~~~~~~~~~~~~

WeeChat provides 6 scripting plugins: Python, Perl, Ruby, Lua, Tcl and Guile
(scheme).
These plugins can load, execute and unload scripts for these languages.

Another plugin called "script" is a scripts manager and is used to load/unload
scripts of any language, and install/remove scripts of WeeChat scripts
repository, which are visible at this URL: http://www.weechat.org/scripts

For more information about how to write scripts, or WeeChat API for
scripts, please read 'WeeChat Scripting Guide'.

[[script_options]]
Script options (script.conf)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

include::autogen/user/script_options.txt[]

[[script_commands]]
Script commands
^^^^^^^^^^^^^^^

include::autogen/user/script_commands.txt[]

[[python_commands]]
Python commands
^^^^^^^^^^^^^^^

include::autogen/user/python_commands.txt[]

[[perl_commands]]
Perl commands
^^^^^^^^^^^^^

include::autogen/user/perl_commands.txt[]

[[ruby_commands]]
Ruby commands
^^^^^^^^^^^^^

include::autogen/user/ruby_commands.txt[]

[[lua_commands]]
Lua commands
^^^^^^^^^^^^

include::autogen/user/lua_commands.txt[]

[[tcl_commands]]
Tcl commands
^^^^^^^^^^^^

include::autogen/user/tcl_commands.txt[]

[[guile_commands]]
Guile commands
^^^^^^^^^^^^^^

include::autogen/user/guile_commands.txt[]

[[xfer_plugin]]
Xfer plugin
~~~~~~~~~~~

Xfer plugin brings:

* direct chat (between two hosts, without server): for example "DCC Chat" via
  IRC plugin
* file transfer, for example "DCC" via IRC plugin

[[xfer_options]]
Options (xfer.conf)
^^^^^^^^^^^^^^^^^^^^^

include::autogen/user/xfer_options.txt[]

[[xfer_commands]]
Commands
^^^^^^^^

include::autogen/user/xfer_commands.txt[]

[[support]]
Support
-------

Before asking for support, be sure you've read documentation and FAQ provided
with WeeChat (documentation is this document, if you don't read all lines
until this sentence, you can start again!).

Ways to get support:

* IRC: server 'irc.freenode.net', channels '#weechat' (English) and
  '#weechat-fr' (French)
* Mailing list:
** subscribe: http://mail.nongnu.org/mailman/listinfo/weechat-support
** send mail to weechat-support@nongnu.org
** archives: http://mail.nongnu.org/archive/html/weechat-support