summaryrefslogtreecommitdiff
path: root/doc/en/autogen/irc_options.xml
blob: 4bfdd15ae36d3c3bd1a5e0d1db8bbf12145b4f0a (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
<?xml version="1.0" encoding="UTF-8"?>
<!--
     ********* WARNING! *********

     This file is autogenerated with docgen.pl script. *** DO NOT EDIT! ***
     docgen.pl builds XML doc files to include in many languages
-->

<command>irc.color.input_nick</command>: color for nick in input bar
<itemizedlist>
  <listitem>
    <para>type: color</para>
  </listitem>
  <listitem>
    <para>values: a color name (default value: lightcyan)</para>
  </listitem>
</itemizedlist>

<command>irc.color.message_join</command>: color for text in join messages
<itemizedlist>
  <listitem>
    <para>type: color</para>
  </listitem>
  <listitem>
    <para>values: a color name (default value: green)</para>
  </listitem>
</itemizedlist>

<command>irc.color.message_quit</command>: color for text in part/quit messages
<itemizedlist>
  <listitem>
    <para>type: color</para>
  </listitem>
  <listitem>
    <para>values: a color name (default value: red)</para>
  </listitem>
</itemizedlist>

<command>irc.look.color_nicks_in_server_messages</command>: use nick color in messages from server
<itemizedlist>
  <listitem>
    <para>type: boolean</para>
  </listitem>
  <listitem>
    <para>values: on, off (default value: on)</para>
  </listitem>
</itemizedlist>

<command>irc.look.display_away</command>: display message when (un)marking as away
<itemizedlist>
  <listitem>
    <para>type: integer</para>
  </listitem>
  <listitem>
    <para>values: off, local, channel (default value: local)</para>
  </listitem>
</itemizedlist>

<command>irc.look.display_channel_modes</command>: display channel modes in "buffer_name" bar item
<itemizedlist>
  <listitem>
    <para>type: boolean</para>
  </listitem>
  <listitem>
    <para>values: on, off (default value: on)</para>
  </listitem>
</itemizedlist>

<command>irc.look.display_nick_modes</command>: display nick modes in "input_prompt" bar item
<itemizedlist>
  <listitem>
    <para>type: boolean</para>
  </listitem>
  <listitem>
    <para>values: on, off (default value: on)</para>
  </listitem>
</itemizedlist>

<command>irc.look.display_old_topic</command>: display old topic when channel topic is changed
<itemizedlist>
  <listitem>
    <para>type: boolean</para>
  </listitem>
  <listitem>
    <para>values: on, off (default value: on)</para>
  </listitem>
</itemizedlist>

<command>irc.look.hide_nickserv_pwd</command>: hide password displayed by nickserv
<itemizedlist>
  <listitem>
    <para>type: boolean</para>
  </listitem>
  <listitem>
    <para>values: on, off (default value: on)</para>
  </listitem>
</itemizedlist>

<command>irc.look.highlight_tags</command>: comma separated list of tags for messages that may produce highlight (usually any message from another user, not server messages,..)
<itemizedlist>
  <listitem>
    <para>type: string</para>
  </listitem>
  <listitem>
    <para>values: any string (default value: 'irc_privmsg,irc_notice')</para>
  </listitem>
</itemizedlist>

<command>irc.look.nick_completion_smart</command>: smart completion for nicks (completes with last speakers first)
<itemizedlist>
  <listitem>
    <para>type: boolean</para>
  </listitem>
  <listitem>
    <para>values: on, off (default value: on)</para>
  </listitem>
</itemizedlist>

<command>irc.look.nick_prefix</command>: text to display before nick in chat window
<itemizedlist>
  <listitem>
    <para>type: string</para>
  </listitem>
  <listitem>
    <para>values: any string (default value: '')</para>
  </listitem>
</itemizedlist>

<command>irc.look.nick_suffix</command>: text to display after nick in chat window
<itemizedlist>
  <listitem>
    <para>type: string</para>
  </listitem>
  <listitem>
    <para>values: any string (default value: '')</para>
  </listitem>
</itemizedlist>

<command>irc.look.notice_as_pv</command>: display notices as private messages
<itemizedlist>
  <listitem>
    <para>type: boolean</para>
  </listitem>
  <listitem>
    <para>values: on, off (default value: off)</para>
  </listitem>
</itemizedlist>

<command>irc.look.one_server_buffer</command>: use same buffer for all servers
<itemizedlist>
  <listitem>
    <para>type: boolean</para>
  </listitem>
  <listitem>
    <para>values: on, off (default value: off)</para>
  </listitem>
</itemizedlist>

<command>irc.look.open_near_server</command>: open new channels/privates near server
<itemizedlist>
  <listitem>
    <para>type: boolean</para>
  </listitem>
  <listitem>
    <para>values: on, off (default value: off)</para>
  </listitem>
</itemizedlist>

<command>irc.look.show_away_once</command>: show remote away message only once in private
<itemizedlist>
  <listitem>
    <para>type: boolean</para>
  </listitem>
  <listitem>
    <para>values: on, off (default value: on)</para>
  </listitem>
</itemizedlist>

<command>irc.look.smart_filter</command>: filter join/part/quit messages for a nick if not speaking for some minutes on channel (you must create a filter on tag "irc_smart_filter")
<itemizedlist>
  <listitem>
    <para>type: boolean</para>
  </listitem>
  <listitem>
    <para>values: on, off (default value: off)</para>
  </listitem>
</itemizedlist>

<command>irc.look.smart_filter_delay</command>: delay for filtering join/part/quit messages (in minutes)
<itemizedlist>
  <listitem>
    <para>type: integer</para>
  </listitem>
  <listitem>
    <para>values: 1 .. 10080 (default value: 5)</para>
  </listitem>
</itemizedlist>

<command>irc.look.topic_strip_colors</command>: strip colors in topic (used only when displaying buffer title)
<itemizedlist>
  <listitem>
    <para>type: boolean</para>
  </listitem>
  <listitem>
    <para>values: on, off (default value: off)</para>
  </listitem>
</itemizedlist>

<command>irc.network.anti_flood</command>: anti-flood: # seconds between two user messages (0 = no anti-flood)
<itemizedlist>
  <listitem>
    <para>type: integer</para>
  </listitem>
  <listitem>
    <para>values: 0 .. 5 (default value: 2)</para>
  </listitem>
</itemizedlist>

<command>irc.network.away_check</command>: interval between two checks for away (in minutes, 0 = never check)
<itemizedlist>
  <listitem>
    <para>type: integer</para>
  </listitem>
  <listitem>
    <para>values: 0 .. 2147483647 (default value: 0)</para>
  </listitem>
</itemizedlist>

<command>irc.network.away_check_max_nicks</command>: do not check away nicks on channels with high number of nicks (0 = unlimited)
<itemizedlist>
  <listitem>
    <para>type: integer</para>
  </listitem>
  <listitem>
    <para>values: 0 .. 2147483647 (default value: 0)</para>
  </listitem>
</itemizedlist>

<command>irc.network.colors_receive</command>: when off, colors codes are ignored in incoming messages
<itemizedlist>
  <listitem>
    <para>type: boolean</para>
  </listitem>
  <listitem>
    <para>values: on, off (default value: on)</para>
  </listitem>
</itemizedlist>

<command>irc.network.colors_send</command>: allow user to send colors with special codes (^Cb=bold, ^Ccxx=color, ^Ccxx,yy=color+background, ^Cu=underline, ^Cr=reverse)
<itemizedlist>
  <listitem>
    <para>type: boolean</para>
  </listitem>
  <listitem>
    <para>values: on, off (default value: on)</para>
  </listitem>
</itemizedlist>

<command>irc.network.default_msg_part</command>: default part message (leaving channel) ('%v' will be replaced by WeeChat version in string)
<itemizedlist>
  <listitem>
    <para>type: string</para>
  </listitem>
  <listitem>
    <para>values: any string (default value: 'WeeChat %v')</para>
  </listitem>
</itemizedlist>

<command>irc.network.default_msg_quit</command>: default quit message (disconnecting from server) ('%v' will be replaced by WeeChat version in string)
<itemizedlist>
  <listitem>
    <para>type: string</para>
  </listitem>
  <listitem>
    <para>values: any string (default value: 'WeeChat %v')</para>
  </listitem>
</itemizedlist>

<command>irc.network.lag_check</command>: interval between two checks for lag (in seconds, 0 = never check)
<itemizedlist>
  <listitem>
    <para>type: integer</para>
  </listitem>
  <listitem>
    <para>values: 0 .. 2147483647 (default value: 60)</para>
  </listitem>
</itemizedlist>

<command>irc.network.lag_disconnect</command>: disconnect after important lag (in minutes, 0 = never disconnect)
<itemizedlist>
  <listitem>
    <para>type: integer</para>
  </listitem>
  <listitem>
    <para>values: 0 .. 2147483647 (default value: 5)</para>
  </listitem>
</itemizedlist>

<command>irc.network.lag_min_show</command>: minimum lag to show (in seconds)
<itemizedlist>
  <listitem>
    <para>type: integer</para>
  </listitem>
  <listitem>
    <para>values: 0 .. 2147483647 (default value: 1)</para>
  </listitem>
</itemizedlist>

<command>irc.network.send_unknown_commands</command>: send unknown commands to server
<itemizedlist>
  <listitem>
    <para>type: boolean</para>
  </listitem>
  <listitem>
    <para>values: on, off (default value: off)</para>
  </listitem>
</itemizedlist>

<command>irc.server_default.addresses</command>: list of hostname/port or IP/port for server (separated by comma)
<itemizedlist>
  <listitem>
    <para>type: string</para>
  </listitem>
  <listitem>
    <para>values: any string (default value: '')</para>
  </listitem>
</itemizedlist>

<command>irc.server_default.autoconnect</command>: automatically connect to server when WeeChat is starting
<itemizedlist>
  <listitem>
    <para>type: boolean</para>
  </listitem>
  <listitem>
    <para>values: on, off (default value: off)</para>
  </listitem>
</itemizedlist>

<command>irc.server_default.autojoin</command>: comma separated list of channels to join when connected to server (example: "#chan1,#chan2,#chan3 key1,key2")
<itemizedlist>
  <listitem>
    <para>type: string</para>
  </listitem>
  <listitem>
    <para>values: any string (default value: '')</para>
  </listitem>
</itemizedlist>

<command>irc.server_default.autoreconnect</command>: automatically reconnect to server when disconnected
<itemizedlist>
  <listitem>
    <para>type: boolean</para>
  </listitem>
  <listitem>
    <para>values: on, off (default value: on)</para>
  </listitem>
</itemizedlist>

<command>irc.server_default.autoreconnect_delay</command>: delay (in seconds) before trying again to reconnect to server
<itemizedlist>
  <listitem>
    <para>type: integer</para>
  </listitem>
  <listitem>
    <para>values: 0 .. 65535 (default value: 30)</para>
  </listitem>
</itemizedlist>

<command>irc.server_default.autorejoin</command>: automatically rejoin channels when kicked
<itemizedlist>
  <listitem>
    <para>type: boolean</para>
  </listitem>
  <listitem>
    <para>values: on, off (default value: off)</para>
  </listitem>
</itemizedlist>

<command>irc.server_default.command</command>: command(s) to run when connected to server (many commands should be separated by ';', use '\;' for a semicolon, special variables $nick, $channel and $server are replaced by their value)
<itemizedlist>
  <listitem>
    <para>type: string</para>
  </listitem>
  <listitem>
    <para>values: any string (default value: '')</para>
  </listitem>
</itemizedlist>

<command>irc.server_default.command_delay</command>: delay (in seconds) after command was executed (example: give some time for authentication)
<itemizedlist>
  <listitem>
    <para>type: integer</para>
  </listitem>
  <listitem>
    <para>values: 0 .. 3600 (default value: 0)</para>
  </listitem>
</itemizedlist>

<command>irc.server_default.ipv6</command>: use IPv6 protocol for server communication
<itemizedlist>
  <listitem>
    <para>type: boolean</para>
  </listitem>
  <listitem>
    <para>values: on, off (default value: off)</para>
  </listitem>
</itemizedlist>

<command>irc.server_default.local_hostname</command>: custom local hostname/IP for server (optional, if empty local hostname is used)
<itemizedlist>
  <listitem>
    <para>type: string</para>
  </listitem>
  <listitem>
    <para>values: any string (default value: '')</para>
  </listitem>
</itemizedlist>

<command>irc.server_default.nicks</command>: nicknames to use on server (separated by comma)
<itemizedlist>
  <listitem>
    <para>type: string</para>
  </listitem>
  <listitem>
    <para>values: any string (default value: '')</para>
  </listitem>
</itemizedlist>

<command>irc.server_default.password</command>: password for server
<itemizedlist>
  <listitem>
    <para>type: string</para>
  </listitem>
  <listitem>
    <para>values: any string (default value: '')</para>
  </listitem>
</itemizedlist>

<command>irc.server_default.proxy</command>: proxy used for this server (optional)
<itemizedlist>
  <listitem>
    <para>type: string</para>
  </listitem>
  <listitem>
    <para>values: any string (default value: '')</para>
  </listitem>
</itemizedlist>

<command>irc.server_default.realname</command>: real name to use on server
<itemizedlist>
  <listitem>
    <para>type: string</para>
  </listitem>
  <listitem>
    <para>values: any string (default value: '')</para>
  </listitem>
</itemizedlist>

<command>irc.server_default.ssl</command>: use SSL for server communication
<itemizedlist>
  <listitem>
    <para>type: boolean</para>
  </listitem>
  <listitem>
    <para>values: on, off (default value: off)</para>
  </listitem>
</itemizedlist>

<command>irc.server_default.username</command>: user name to use on server
<itemizedlist>
  <listitem>
    <para>type: string</para>
  </listitem>
  <listitem>
    <para>values: any string (default value: '')</para>
  </listitem>
</itemizedlist>