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
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="AUTHOR" content="Markus Uhlin">
<meta name="GENERATOR" content="GNU Emacs">
<title>Configuration options</title>
<link rel="stylesheet" href="style.css">
<style>
#conf {}
#conf td.desc {}
#conf span.opttype {
color: royalblue;
text-decoration: underline;
}
.note {
color: red;
font-weight: bold;
}
</style>
</head>
<body>
<h1>Configuration options in swirc.conf</h1>
<p>
<span class="note">NOTE</span>
Certain settings take effect first after program restart while others
don't!
</p>
<table id="conf">
<!-- ============== -->
<!-- ACCOUNT NOTIFY -->
<!-- ============== -->
<tr>
<td>
<strong>account_notify</strong>
(<span class="opttype">bool</span>)
</td>
</tr>
<tr>
<td class="desc">
Allows a client to be notified when another client’s accountname
changes
</td>
</tr>
<tr><td> </td></tr>
<!-- =========== -->
<!-- ACCOUNT TAG -->
<!-- =========== -->
<tr>
<td>
<strong>account_tag</strong>
(<span class="opttype">bool</span>)
</td>
</tr>
<tr>
<td class="desc">
Turns the IRCv3 account tag extension on/off.
</td>
</tr>
<tr><td> </td></tr>
<!-- ======== -->
<!-- ALT NICK -->
<!-- ======== -->
<tr>
<td>
<strong>alt_nick</strong>
(<span class="opttype">string</span>)
</td>
</tr>
<tr>
<td class="desc">
Alternative nickname.
This nickname is used when processing a connection to a server and the
default nickname is busy.
</td>
</tr>
<tr><td> </td></tr>
<!-- ================ -->
<!-- AUTO OP YOURSELF -->
<!-- ================ -->
<tr>
<td>
<strong>auto_op_yourself</strong>
(<span class="opttype">bool</span>)
</td>
</tr>
<tr>
<td class="desc">
Automatically op yourself on channel join when you're identified as an
IRC operator
</td>
</tr>
<tr><td> </td></tr>
<!-- ==================== -->
<!-- AWAYMSGS IN PRIVCONV -->
<!-- ==================== -->
<tr>
<td>
<strong>awaymsgs_in_privconv</strong>
(<span class="opttype">bool</span>)
</td>
</tr>
<tr>
<td class="desc">
Output away messages in private conversations?
Away messages are often displayed each time you
message the user who's marked as being away which can
be annoying if the user isn't really away, i.e. he/she
just forgot to unset the status.
This setting defaults to YES.
</td>
</tr>
<tr><td> </td></tr>
<!-- =========== -->
<!-- AWAY NOTIFY -->
<!-- =========== -->
<tr>
<td>
<strong>away_notify</strong>
(<span class="opttype">bool</span>)
</td>
</tr>
<tr>
<td class="desc">
Allows a client to specify that it would like to be notified when
users are marked/unmarked as away
</td>
</tr>
<tr><td> </td></tr>
<!-- ===== -->
<!-- BEEPS -->
<!-- ===== -->
<tr>
<td>
<strong>beeps</strong>
(<span class="opttype">bool</span>)
</td>
</tr>
<tr>
<td class="desc">
<strong>swirc</strong> alerts the user by sending a beep in certain cases.
However, with the help of this setting, beeps can be turned on/off.
</td>
</tr>
<tr><td> </td></tr>
<!-- ============= -->
<!-- CHANSERV HOST -->
<!-- ============= -->
<tr>
<td>
<strong>chanserv_host</strong>
(<span class="opttype">string</span>)
</td>
</tr>
<tr>
<td class="desc">
ChanServ hostname
</td>
</tr>
<tr><td> </td></tr>
<!-- ======= -->
<!-- CHGHOST -->
<!-- ======= -->
<tr>
<td>
<strong>chghost</strong>
(<span class="opttype">bool</span>)
</td>
</tr>
<tr>
<td class="desc">
Allows servers to send a notification when clients change their
username or host (IRCv3 feature).
Defaults to yes.
</td>
</tr>
<tr><td> </td></tr>
<!-- ============ -->
<!-- CIPHER SUITE -->
<!-- ============ -->
<tr>
<td>
<strong>cipher_suite</strong>
(<span class="opttype">string</span>)
</td>
</tr>
<tr>
<td class="desc">
Cipher suite. Which can have one of the following values:
<ul>
<li>secure</li>
<li>compat</li>
<li>legacy</li>
<li>all</li>
</ul>
</td>
</tr>
<!--<tr><td> </td></tr>-->
<!-- ============= -->
<!-- CMD HIST SIZE -->
<!-- ============= -->
<tr>
<td>
<strong>cmd_hist_size</strong>
(<span class="opttype">int</span>)
</td>
</tr>
<tr>
<td class="desc">
Command history size.
No more than this number of commands will be stored in the memory.
</td>
</tr>
<tr><td> </td></tr>
<!-- ============= -->
<!-- CMD TYPE PROT -->
<!-- ============= -->
<tr>
<td>
<strong>cmd_type_prot</strong>
(<span class="opttype">bool</span>)
</td>
</tr>
<tr>
<td class="desc">
Command type protection.
Detects up to 5 leading spaces followed by a command character
preventing a command to be accidentally transmitted as a chat message.
</td>
</tr>
<tr><td> </td></tr>
<!-- ================== -->
<!-- CONNECTION TIMEOUT -->
<!-- ================== -->
<tr>
<td>
<strong>connection_timeout</strong>
(<span class="opttype">int</span>)
</td>
</tr>
<tr>
<td class="desc">
Connection timeout in seconds
</td>
</tr>
<tr><td> </td></tr>
<!-- ========== -->
<!-- CTCP REPLY -->
<!-- ========== -->
<tr>
<td>
<strong>ctcp_reply</strong>
(<span class="opttype">bool</span>)
</td>
</tr>
<tr>
<td class="desc">
Reply to CTCP requests?
(For example TIME and VERSION.)
</td>
</tr>
<tr><td> </td></tr>
<!-- ============= -->
<!-- CTCP USERINFO -->
<!-- ============= -->
<tr>
<td>
<strong>ctcp_userinfo</strong>
(<span class="opttype">string</span>)
</td>
</tr>
<tr>
<td class="desc">
A string to return on a CTCP userinfo request.
</td>
</tr>
<tr><td> </td></tr>
<!-- === -->
<!-- DCC -->
<!-- === -->
<tr>
<td>
<strong>dcc</strong>
(<span class="opttype">bool</span>)
</td>
</tr>
<tr>
<td class="desc">
Use DCC (Direct Client-to-Client)?
Swirc implements its own variant of DCC meaning it's
incompatible with other IRC clients.
Transport Layer Security is forced and for now the DCC
feature isn't available in ICB mode.
</td>
</tr>
<tr><td> </td></tr>
<!-- ================ -->
<!-- DCC CIPHER SUITE -->
<!-- ================ -->
<tr>
<td>
<strong>dcc_cipher_suite</strong>
(<span class="opttype">string</span>)
</td>
</tr>
<tr>
<td class="desc">
DCC cipher suite.
Which can be:
<strong>secure</strong>,
<strong>compat</strong>,
<strong>legacy</strong> or
<strong>all</strong>.
</td>
</tr>
<tr><td> </td></tr>
<!-- ========== -->
<!-- DCC OWN IP -->
<!-- ========== -->
<tr>
<td>
<strong>dcc_own_ip</strong>
(<span class="opttype">string</span>)
</td>
</tr>
<tr>
<td class="desc">
IPv4 address for incoming DCC connections.
If empty Swirc attempts to resovle the address
automatically.
</td>
</tr>
<tr><td> </td></tr>
<!-- ======== -->
<!-- DCC PORT -->
<!-- ======== -->
<tr>
<td>
<strong>dcc_port</strong>
(<span class="opttype">int</span>)
</td>
</tr>
<tr>
<td class="desc">
Port number for incoming DCC connections (1024-65535),
defaults to 8080.
Must not be blocked by a firewall.
</td>
</tr>
<tr><td> </td></tr>
<!-- ============== -->
<!-- DCC UPLOAD DIR -->
<!-- ============== -->
<tr>
<td>
<strong>dcc_upload_dir</strong>
(<span class="opttype">string</span>)
</td>
</tr>
<tr>
<td class="desc">
Where shall Swirc look for DCC uploads?
If empty it defaults to <em>uploads</em> in the home
dir of Swirc.
On OpenBSD this dir is made available with read-only
permissions by using
<a href="https://man.openbsd.org/unveil.2">unveil(2)</a>.
However, that is done once at startup.
Changing it while Swirc is running will not work.
</td>
</tr>
<tr><td> </td></tr>
<!-- ============= -->
<!-- EXTENDED JOIN -->
<!-- ============= -->
<tr>
<td>
<strong>extended_join</strong>
(<span class="opttype">bool</span>)
</td>
</tr>
<tr>
<td class="desc">
Turns the extended-join IRCv3 feature on/off.
</td>
</tr>
<tr><td> </td></tr>
<!-- ======== -->
<!-- FTP HOST -->
<!-- ======== -->
<tr>
<td>
<strong>ftp_host</strong>
(<span class="opttype">string</span>)
</td>
</tr>
<tr>
<td class="desc">
FTP hostname.
</td>
</tr>
<tr><td> </td></tr>
<!-- ======== -->
<!-- FTP PORT -->
<!-- ======== -->
<tr>
<td>
<strong>ftp_port</strong>
(<span class="opttype">int</span>)
</td>
</tr>
<tr>
<td class="desc">
FTP port number (1-65535).
Defaults to 21.
</td>
</tr>
<tr><td> </td></tr>
<!-- ======== -->
<!-- FTP USER -->
<!-- ======== -->
<tr>
<td>
<strong>ftp_user</strong>
(<span class="opttype">string</span>)
</td>
</tr>
<tr>
<td class="desc">
FTP username.
Defaults to anonymous.
</td>
</tr>
<tr><td> </td></tr>
<!-- ======== -->
<!-- FTP PASS -->
<!-- ======== -->
<tr>
<td>
<strong>ftp_pass</strong>
(<span class="opttype">string</span>)
</td>
</tr>
<tr>
<td class="desc">
FTP password.
</td>
</tr>
<tr><td> </td></tr>
<!-- ============== -->
<!-- FTP UPLOAD DIR -->
<!-- ============== -->
<tr>
<td>
<strong>ftp_upload_dir</strong>
(<span class="opttype">string</span>)
</td>
</tr>
<tr>
<td class="desc">
FTP upload directory.
</td>
</tr>
<tr><td> </td></tr>
<!-- ================= -->
<!-- HOSTNAME CHECKING -->
<!-- ================= -->
<tr>
<td>
<strong>hostname_checking</strong>
(<span class="opttype">bool</span>)
</td>
</tr>
<tr>
<td class="desc">
Enable or disable TLS/SSL hostname verification
</td>
</tr>
<tr><td> </td></tr>
<!-- ================ -->
<!-- ICONV CONVERSION -->
<!-- ================ -->
<tr>
<td>
<strong>iconv_conversion</strong>
(<span class="opttype">bool</span>)
</td>
</tr>
<tr>
<td class="desc">
Perform character conversion using GNU libiconv?
If having this option set to 'on' causes troubles or if you don't need
it, it can safely be switched off.
Switching it off boosts the performance of the printtext module
significantly.
</td>
</tr>
<tr><td> </td></tr>
<!-- ====== -->
<!-- IDENTD -->
<!-- ====== -->
<tr>
<td>
<strong>identd</strong>
(<span class="opttype">bool</span>)
</td>
</tr>
<tr>
<td class="desc">
Use the built-in ident protocol daemon/server?
It's automatically started and stopped during the connection process
if this option is enabled.
During the connection process to an IRC server the IRC server often
attempts to send an ident query to port 113 on your computer.
You might have seen something like:
<pre>
*** Processing connection to irc.server.com
*** Looking up your hostname...
*** Checking Ident
*** No Ident response <---
*** Found your hostname
</pre>
(This requires port 113 to be open, i.e. not behind a firewall.)
</td>
</tr>
<tr><td> </td></tr>
<!-- ================ -->
<!-- IDENTD FAKENAMES -->
<!-- ================ -->
<tr>
<td>
<strong>identd_fakenames</strong>
(<span class="opttype">bool</span>)
</td>
</tr>
<tr>
<td class="desc">
Respond to ident queries with fake (randomized) names?
</td>
</tr>
<tr><td> </td></tr>
<!-- =========== -->
<!-- IDENTD PORT -->
<!-- =========== -->
<tr>
<td>
<strong>identd_port</strong>
(<span class="opttype">int</span>)
</td>
</tr>
<tr>
<td class="desc">
Which port shall the ident server listen on?
In general, on Unix only root can listen on ports below 1024.
Since you neither CAN or SHOULD run Swirc as root you should specify a
different port using this setting and configure your firewall to
redirect connections to port 113 to this one.
</td>
</tr>
<tr>
<td class="desc">
If you're using
<a href="http://www.openbsd.org/">OpenBSD</a>
and
<a href="https://man.openbsd.org/pf.4">pf(4)</a>,
pose that you want use port 6500 and that the name of the target
interface is vio0.
You could then add the following lines to your
<a href="https://man.openbsd.org/pf.conf.5">pf.conf(5)</a>:
<pre>
pass in on vio0 inet proto tcp from any to any port auth \
rdr-to 127.0.0.1 port 6500
pass in on vio0 inet6 proto tcp from any to any port auth \
rdr-to ::1 port 6500
</pre>
</td>
</tr>
<tr><td> </td></tr>
<!-- ============= -->
<!-- INVITE NOTIFY -->
<!-- ============= -->
<tr>
<td>
<strong>invite_notify</strong>
(<span class="opttype">bool</span>)
</td>
</tr>
<tr>
<td class="desc">
Allows a client to specify that it would like to be notified when
users are invited to channels
</td>
</tr>
<tr><td> </td></tr>
<!-- ================= -->
<!-- JOINS PARTS QUITS -->
<!-- ================= -->
<tr>
<td>
<strong>joins_parts_quits</strong>
(<span class="opttype">bool</span>)
</td>
</tr>
<tr>
<td class="desc">
Show JOIN/PART/QUIT events?
</td>
</tr>
<tr><td> </td></tr>
<!-- ================= -->
<!-- KICK CLOSE WINDOW -->
<!-- ================= -->
<tr>
<td>
<strong>kick_close_window</strong>
(<span class="opttype">bool</span>)
</td>
</tr>
<tr>
<td class="desc">
If the active user gets kicked out from a channel, should the channel
window be terminated?
</td>
</tr>
<tr><td> </td></tr>
<!-- ================ -->
<!-- MAX CHAT WINDOWS -->
<!-- ================ -->
<tr>
<td>
<strong>max_chat_windows</strong>
(<span class="opttype">int</span>)
</td>
</tr>
<tr>
<td class="desc">
Max chat windows that can be open simultaneously
</td>
</tr>
<tr><td> </td></tr>
<!-- ===== -->
<!-- MOUSE -->
<!-- ===== -->
<tr>
<td>
<strong>mouse</strong>
(<span class="opttype">bool</span>)
</td>
</tr>
<tr>
<td class="desc">
Use the mouse?
</td>
</tr>
<tr><td> </td></tr>
<!-- ============ -->
<!-- MOUSE EVENTS -->
<!-- ============ -->
<tr>
<td>
<strong>mouse_events</strong>
(<span class="opttype">string</span>)
</td>
</tr>
<tr>
<td class="desc">
Which mouse events shall be reported?
<ul>
<li>all</li>
<li>wheel (default)</li>
</ul>
</td>
</tr>
<tr><td> </td></tr>
<!-- ======== -->
<!-- NICKNAME -->
<!-- ======== -->
<tr>
<td>
<strong>nickname</strong>
(<span class="opttype">string</span>)
</td>
</tr>
<tr>
<td class="desc">
Online nickname
</td>
</tr>
<tr><td> </td></tr>
<!-- ================ -->
<!-- NICKNAME ALIASES -->
<!-- ================ -->
<tr>
<td>
<strong>nickname_aliases</strong>
(<span class="opttype">string</span>)
</td>
</tr>
<tr>
<td class="desc">
A space separated list of nickname aliases which are used, in addition
to the default nickname, to highlight a message if it matches any of
the aliases given by this setting.
</td>
</tr>
<tr><td> </td></tr>
<!-- ============= -->
<!-- NICKSERV HOST -->
<!-- ============= -->
<tr>
<td>
<strong>nickserv_host</strong>
(<span class="opttype">string</span>)
</td>
</tr>
<tr>
<td class="desc">
NickServ hostname
</td>
</tr>
<tr><td> </td></tr>
<!-- ============= -->
<!-- NOTIFICATIONS -->
<!-- ============= -->
<tr>
<td>
<strong>notifications</strong>
(<span class="opttype">bool</span>)
</td>
</tr>
<tr>
<td class="desc">
Turns notifications on/off.
Takes effect at once.
</td>
</tr>
<tr><td> </td></tr>
<!-- ============ -->
<!-- PART MESSAGE -->
<!-- ============ -->
<tr>
<td>
<strong>part_message</strong>
(<span class="opttype">string</span>)
</td>
</tr>
<tr>
<td class="desc">
Message when leaving a channel
</td>
</tr>
<tr><td> </td></tr>
<!-- ========= -->
<!-- QBOT HOST -->
<!-- ========= -->
<tr>
<td>
<strong>qbot_host</strong>
(<span class="opttype">string</span>)
</td>
</tr>
<tr>
<td class="desc">
Q bot hostname.
The Q bot is a
<a href="https://www.quakenet.org/">QuakeNet</a>
service.
</td>
</tr>
<tr><td> </td></tr>
<!-- ============ -->
<!-- QUIT MESSAGE -->
<!-- ============ -->
<tr>
<td>
<strong>quit_message</strong>
(<span class="opttype">string</span>)
</td>
</tr>
<tr>
<td class="desc">
Message when disconnecting from a server
</td>
</tr>
<tr><td> </td></tr>
<!-- ========= -->
<!-- REAL NAME -->
<!-- ========= -->
<tr>
<td>
<strong>real_name</strong>
(<span class="opttype">string</span>)
</td>
</tr>
<tr>
<td class="desc">
Specifies the real name.<br>
But can be set to anything.
</td>
</tr>
<tr><td> </td></tr>
<!-- ======================= -->
<!-- RECONNECT BACKOFF DELAY -->
<!-- ======================= -->
<tr>
<td>
<strong>reconnect_backoff_delay</strong>
(<span class="opttype">int</span>)
</td>
</tr>
<tr>
<td class="desc">
The number of seconds that should be added to each reconnect attempt
(0-99)
</td>
</tr>
<tr><td> </td></tr>
<!-- =============== -->
<!-- RECONNECT DELAY -->
<!-- =============== -->
<tr>
<td>
<strong>reconnect_delay</strong>
(<span class="opttype">int</span>)
</td>
</tr>
<tr>
<td class="desc">
Seconds to consume before the first reconnect attempt (0-999)
</td>
</tr>
<tr><td> </td></tr>
<!-- =================== -->
<!-- RECONNECT DELAY MAX -->
<!-- =================== -->
<tr>
<td>
<strong>reconnect_delay_max</strong>
(<span class="opttype">int</span>)
</td>
</tr>
<tr>
<td class="desc">
Maximum reconnect delay in seconds (0-999).
Regardless of the other related reconnect settings.
</td>
</tr>
<tr><td> </td></tr>
<!-- ================= -->
<!-- RECONNECT RETRIES -->
<!-- ================= -->
<tr>
<td>
<strong>reconnect_retries</strong>
(<span class="opttype">int</span>)
</td>
</tr>
<tr>
<td class="desc">
If the IRC connection is lost, how many attempts should be performed
to get the connection working again before giving up?
</td>
</tr>
<tr><td> </td></tr>
<!-- ==== -->
<!-- SASL -->
<!-- ==== -->
<tr>
<td>
<strong>sasl</strong>
(<span class="opttype">bool</span>)
</td>
</tr>
<tr>
<td class="desc">
Request SASL authentication on connection to a server?
</td>
</tr>
<tr><td> </td></tr>
<!-- ============== -->
<!-- SASL MECHANISM -->
<!-- ============== -->
<tr>
<td>
<strong>sasl_mechanism</strong>
(<span class="opttype">string</span>)
</td>
</tr>
<tr>
<td class="desc">
SASL mechanism.
Available mechanisms are:
<ul>
<li>ECDSA-NIST256P-CHALLENGE</li>
<li>EXTERNAL</li>
<li>PLAIN</li>
<li>SCRAM-SHA-1</li>
<li>SCRAM-SHA-256</li>
<li>SCRAM-SHA-512</li>
</ul>
Be sure to write them in all uppercase!
</td>
</tr>
<tr><td> </td></tr>
<!-- ============= -->
<!-- SASL PASSWORD -->
<!-- ============= -->
<tr>
<td>
<strong>sasl_password</strong>
(<span class="opttype">string</span>)
</td>
</tr>
<tr>
<td class="desc">
SASL password.
(For mechanism PLAIN and SCRAM-SHA-256.)
</td>
</tr>
<tr>
<td class="desc">
It is recommended to set this setting using the interactive sasl
command.
However, if the initial character is a question mark (‘?’) it
symbolizes that the password is in plain text/unencrypted; while a
hash mark (‘#’) symbolizes that the password is encrypted.
The initial character must be either of them and is not interpreted as
a part of the password.
</td>
</tr>
<tr><td> </td></tr>
<!-- ============= -->
<!-- SASL USERNAME -->
<!-- ============= -->
<tr>
<td>
<strong>sasl_username</strong>
(<span class="opttype">string</span>)
</td>
</tr>
<tr>
<td class="desc">
SASL username
</td>
</tr>
<tr><td> </td></tr>
<!-- ========= -->
<!-- SASL X509 -->
<!-- ========= -->
<tr>
<td>
<strong>sasl_x509</strong>
(<span class="opttype">string</span>)
</td>
</tr>
<tr>
<td class="desc">
Filename for your certificate chain file.
The file shall be located in Swirc's home dir and be in PEM
format.
</td>
</tr>
<tr>
<td class="desc">
The certificate chain file is used for automatic NickServ
authentication using the external SASL auth mechanism.
<ul>
<li>1-root-ca.sh (Create the root CA)</li>
<li>
4-client-cert.sh
(Create the client certificate and sign it with the root CA)
</li>
</ul>
</td>
</tr>
<tr>
<td class="desc">
After running the scripts stated above in given order you can set this
setting to
<em>client.pem</em>.
</td>
</tr>
<tr><td> </td></tr>
<!-- =========== -->
<!-- SERVER TIME -->
<!-- =========== -->
<tr>
<td>
<strong>server_time</strong>
(<span class="opttype">bool</span>)
</td>
</tr>
<tr>
<td class="desc">
Enable or disable IRCv3 server time extension.
The server time extension is particularly useful if you're using an
IRC bouncer like
<a href="https://znc.in/">ZNC</a>.
</td>
</tr>
<tr><td> </td></tr>
<!-- ============== -->
<!-- SHOW PING PONG -->
<!-- ============== -->
<tr>
<td>
<strong>show_ping_pong</strong>
(<span class="opttype">bool</span>)
</td>
</tr>
<tr>
<td class="desc">
Show ping pong events?<br>
The default is NO.
</td>
</tr>
<tr><td> </td></tr>
<!-- ========= -->
<!-- SKIP MOTD -->
<!-- ========= -->
<tr>
<td>
<strong>skip_motd</strong>
(<span class="opttype">bool</span>)
</td>
</tr>
<tr>
<td class="desc">
Skip message of the day (MOTD) on connection to a server?
</td>
</tr>
<tr><td> </td></tr>
<!-- ===== -->
<!-- SOCKS -->
<!-- ===== -->
<tr>
<td>
<strong>socks</strong>
(<span class="opttype">bool</span>)
</td>
</tr>
<tr>
<td class="desc">
Use the SOCKS proxy client?
The SOCKS proxy client is particularly suited for use
with Tor.
Examples of IRC networks that are accessible via Tor
are Libera Chat and OFTC.
In order to access Libera Chat or OFTC using the
previously mentioned technique you can add the
following lines to your torrc(5):
<pre>
# Libera Chat
MapAddress palladium.libera.chat libera75jm6of4wxpxt4aynol3xjmbtxgfyjpu34ss4d7r7q2v5zrpyd.onion
# OFTC
MapAddress irc.oftc.net oftcnet6xg6roj6d7id4y4cu6dchysacqj2ldgea73qzdagufflqxrid.onion
</pre>
After this has been done (and after restarting Tor)
you should be able to connect to one of the mapped
addresses inside Swirc.
The socks host setting should point to the machine
where the Tor service is running.
</td>
</tr>
<tr><td> </td></tr>
<!-- ========== -->
<!-- SOCKS ATYP -->
<!-- ========== -->
<tr>
<td>
<strong>socks_atyp</strong>
(<span class="opttype">int</span>)
</td>
</tr>
<tr>
<td class="desc">
SOCKS address type.
Which can have one of the following values:
<ul>
<li>(0) FQDN. (The default.)</li>
<li>(1) IPv4 address</li>
<li>(2) IPv6 address</li>
</ul>
</td>
</tr>
<tr><td> </td></tr>
<!-- ========== -->
<!-- SOCKS HOST -->
<!-- ========== -->
<tr>
<td>
<strong>socks_host</strong>
(<span class="opttype">string</span>)
</td>
</tr>
<tr>
<td class="desc">
SOCKS hostname.
</td>
</tr>
<tr><td> </td></tr>
<!-- ========== -->
<!-- SOCKS PORT -->
<!-- ========== -->
<tr>
<td>
<strong>socks_port</strong>
(<span class="opttype">string</span>)
</td>
</tr>
<tr>
<td class="desc">
SOCKS port.
The default is 9050 which is used by
<a href="https://www.torproject.org/">Tor</a>.
</td>
</tr>
<tr><td> </td></tr>
<!-- ===== -->
<!-- SPELL -->
<!-- ===== -->
<tr>
<td>
<strong>spell</strong>
(<span class="opttype">bool</span>)
</td>
</tr>
<tr>
<td class="desc">
Use spelling?
</td>
</tr>
<tr><td> </td></tr>
<!-- ========== -->
<!-- SPELL LANG -->
<!-- ========== -->
<tr>
<td>
<strong>spell_lang</strong>
(<span class="opttype">string</span>)
</td>
</tr>
<tr>
<td class="desc">
Spelling language.
The default is <strong>en_US</strong>.
</td>
</tr>
<tr><td> </td></tr>
<!-- ============= -->
<!-- SPELL SYSWIDE -->
<!-- ============= -->
<tr>
<td>
<strong>spell_syswide</strong>
(<span class="opttype">bool</span>)
</td>
</tr>
<tr>
<td class="desc">
Where shall Swirc look for spelling dictionaries?
(System wide or in the program settings dir.)
</td>
</tr>
<tr><td> </td></tr>
<!-- =============== -->
<!-- SSL VERIFY PEER -->
<!-- =============== -->
<tr>
<td>
<strong>ssl_verify_peer</strong>
(<span class="opttype">bool</span>)
</td>
</tr>
<tr>
<td class="desc">
Verify peer?
Setting it to NO decreases TLS/SSL security significantly, but is a
must on servers with trusted self signed certificates.
</td>
</tr>
<tr><td> </td></tr>
<!-- ================ -->
<!-- STARTUP GREETING -->
<!-- ================ -->
<tr>
<td>
<strong>startup_greeting</strong>
(<span class="opttype">bool</span>)
</td>
</tr>
<tr>
<td class="desc">
Enable or disable Swirc startup greeting
</td>
</tr>
<tr><td> </td></tr>
<!-- ======================== -->
<!-- TEXTBUFFER SIZE ABSOLUTE -->
<!-- ======================== -->
<tr>
<td>
<strong>textbuffer_size_absolute</strong>
(<span class="opttype">int</span>)
</td>
</tr>
<tr>
<td class="desc">
Max number of elements in a text buffer before head gets removed from scroll back history.
Each open window is assigned a buffer with this size, so set a sane value!
</td>
</tr>
<tr><td> </td></tr>
<!-- ===== -->
<!-- THEME -->
<!-- ===== -->
<tr>
<td>
<strong>theme</strong>
(<span class="opttype">string</span>)
</td>
</tr>
<tr>
<td class="desc">
<strong>swirc</strong> theme.
</td>
</tr>
<tr><td> </td></tr>
<!-- ======== -->
<!-- USERNAME -->
<!-- ======== -->
<tr>
<td>
<strong>username</strong>
(<span class="opttype">string</span>)
</td>
</tr>
<tr>
<td class="desc">
User identity.
Preferably to be set to the same as the nickname.
</td>
</tr>
<tr><td> </td></tr>
<!--
<tr>
<td>
<strong></strong>
(<span class="opttype"></span>)
</td>
</tr>
<tr>
<td class="desc">
</td>
</tr>
<tr><td> </td></tr>
-->
</table> <!-- conf -->
</body>
</html>
|
