summaryrefslogtreecommitdiff
path: root/doc/en/autogen/user/weechat_options.txt
blob: b108d28e069d7cf87ea0f85fe6bdd35737e74d16 (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
* *weechat.color.bar_more*
** description: `text color for '+' when scrolling bars`
** type: color
** values: a color name (default value: `lightmagenta`)

* *weechat.color.chat*
** description: `text color for chat`
** type: color
** values: a color name (default value: `default`)

* *weechat.color.chat_bg*
** description: `background color for chat`
** type: color
** values: a color name (default value: `default`)

* *weechat.color.chat_buffer*
** description: `text color for buffer names`
** type: color
** values: a color name (default value: `white`)

* *weechat.color.chat_channel*
** description: `text color for channel names`
** type: color
** values: a color name (default value: `white`)

* *weechat.color.chat_delimiters*
** description: `text color for delimiters`
** type: color
** values: a color name (default value: `green`)

* *weechat.color.chat_highlight*
** description: `text color for highlighted prefix`
** type: color
** values: a color name (default value: `yellow`)

* *weechat.color.chat_highlight_bg*
** description: `background color for highlighted prefix`
** type: color
** values: a color name (default value: `magenta`)

* *weechat.color.chat_host*
** description: `text color for hostnames`
** type: color
** values: a color name (default value: `cyan`)

* *weechat.color.chat_nick*
** description: `text color for nicks in chat window`
** type: color
** values: a color name (default value: `lightcyan`)

* *weechat.color.chat_nick_colors*
** description: `text color for nicks (comma separated list of colors, background is allowed with format: "fg/bg", for example: "blue/red")`
** type: string
** values: any string (default value: `"cyan,magenta,green,brown,lightblue,default,lightcyan,lightmagenta,lightgreen,blue"`)

* *weechat.color.chat_nick_other*
** description: `text color for other nick in private buffer`
** type: color
** values: a color name (default value: `cyan`)

* *weechat.color.chat_nick_self*
** description: `text color for local nick in chat window`
** type: color
** values: a color name (default value: `white`)

* *weechat.color.chat_prefix_action*
** description: `text color for action prefix`
** type: color
** values: a color name (default value: `white`)

* *weechat.color.chat_prefix_buffer*
** description: `text color for buffer name (before prefix, when many buffers are merged with same number)`
** type: color
** values: a color name (default value: `brown`)

* *weechat.color.chat_prefix_error*
** description: `text color for error prefix`
** type: color
** values: a color name (default value: `yellow`)

* *weechat.color.chat_prefix_join*
** description: `text color for join prefix`
** type: color
** values: a color name (default value: `lightgreen`)

* *weechat.color.chat_prefix_more*
** description: `text color for '+' when prefix is too long`
** type: color
** values: a color name (default value: `lightmagenta`)

* *weechat.color.chat_prefix_network*
** description: `text color for network prefix`
** type: color
** values: a color name (default value: `magenta`)

* *weechat.color.chat_prefix_quit*
** description: `text color for quit prefix`
** type: color
** values: a color name (default value: `lightred`)

* *weechat.color.chat_prefix_suffix*
** description: `text color for suffix (after prefix)`
** type: color
** values: a color name (default value: `green`)

* *weechat.color.chat_read_marker*
** description: `text color for unread data marker`
** type: color
** values: a color name (default value: `magenta`)

* *weechat.color.chat_read_marker_bg*
** description: `background color for unread data marker`
** type: color
** values: a color name (default value: `default`)

* *weechat.color.chat_server*
** description: `text color for server names`
** type: color
** values: a color name (default value: `brown`)

* *weechat.color.chat_text_found*
** description: `text color for marker on lines where text sought is found`
** type: color
** values: a color name (default value: `yellow`)

* *weechat.color.chat_text_found_bg*
** description: `background color for marker on lines where text sought is found`
** type: color
** values: a color name (default value: `lightmagenta`)

* *weechat.color.chat_time*
** description: `text color for time in chat window`
** type: color
** values: a color name (default value: `default`)

* *weechat.color.chat_time_delimiters*
** description: `text color for time delimiters`
** type: color
** values: a color name (default value: `brown`)

* *weechat.color.chat_value*
** description: `text color for values`
** type: color
** values: a color name (default value: `cyan`)

* *weechat.color.input_actions*
** description: `text color for actions in input line`
** type: color
** values: a color name (default value: `lightgreen`)

* *weechat.color.input_text_not_found*
** description: `text color for unsucessful text search in input line`
** type: color
** values: a color name (default value: `red`)

* *weechat.color.nicklist_away*
** description: `text color for away nicknames`
** type: color
** values: a color name (default value: `cyan`)

* *weechat.color.nicklist_group*
** description: `text color for groups in nicklist`
** type: color
** values: a color name (default value: `green`)

* *weechat.color.nicklist_offline*
** description: `text color for offline nicknames`
** type: color
** values: a color name (default value: `blue`)

* *weechat.color.separator*
** description: `background color for window separators (when split)`
** type: color
** values: a color name (default value: `blue`)

* *weechat.color.status_data_highlight*
** description: `text color for buffer with highlight (status bar)`
** type: color
** values: a color name (default value: `lightmagenta`)

* *weechat.color.status_data_msg*
** description: `text color for buffer with new messages (status bar)`
** type: color
** values: a color name (default value: `yellow`)

* *weechat.color.status_data_other*
** description: `text color for buffer with new data (not messages) (status bar)`
** type: color
** values: a color name (default value: `default`)

* *weechat.color.status_data_private*
** description: `text color for buffer with private message (status bar)`
** type: color
** values: a color name (default value: `lightgreen`)

* *weechat.color.status_filter*
** description: `text color for filter indicator in status bar`
** type: color
** values: a color name (default value: `green`)

* *weechat.color.status_more*
** description: `text color for buffer with new data (status bar)`
** type: color
** values: a color name (default value: `yellow`)

* *weechat.color.status_name*
** description: `text color for current buffer name in status bar`
** type: color
** values: a color name (default value: `white`)

* *weechat.color.status_name_ssl*
** description: `text color for current buffer name in status bar, if data are secured with a protocol like SSL`
** type: color
** values: a color name (default value: `lightgreen`)

* *weechat.color.status_number*
** description: `text color for current buffer number in status bar`
** type: color
** values: a color name (default value: `yellow`)

* *weechat.color.status_time*
** description: `text color for time (status bar)`
** type: color
** values: a color name (default value: `default`)

* *weechat.completion.default_template*
** description: `default completion template (please see documentation for template codes and values)`
** type: string
** values: any string (default value: `"%(nicks)|%(irc_channels)"`)

* *weechat.completion.nick_add_space*
** description: `add space after nick completion (when nick is not first word on command line)`
** type: boolean
** values: on, off (default value: `on`)

* *weechat.completion.nick_completer*
** description: `string inserted after nick completion`
** type: string
** values: any string (default value: `":"`)

* *weechat.completion.nick_first_only*
** description: `complete only with first nick found`
** type: boolean
** values: on, off (default value: `off`)

* *weechat.completion.nick_ignore_chars*
** description: `chars ignored for nick completion`
** type: string
** values: any string (default value: `"[]-^"`)

* *weechat.completion.partial_completion_alert*
** description: `alert user when a partial completion occurs`
** type: boolean
** values: on, off (default value: `on`)

* *weechat.completion.partial_completion_command*
** description: `partially complete command names (stop when many commands found begin with same letters)`
** type: boolean
** values: on, off (default value: `off`)

* *weechat.completion.partial_completion_command_arg*
** description: `partially complete command arguments (stop when many arguments found begin with same prefix)`
** type: boolean
** values: on, off (default value: `off`)

* *weechat.completion.partial_completion_count*
** description: `display count for each partial completion in bar item`
** type: boolean
** values: on, off (default value: `on`)

* *weechat.completion.partial_completion_other*
** description: `partially complete outside commands (stop when many words found begin with same letters)`
** type: boolean
** values: on, off (default value: `off`)

* *weechat.history.display_default*
** description: `maximum number of commands to display by default in history listing (0 = unlimited)`
** type: integer
** values: 0 .. 2147483647 (default value: `5`)

* *weechat.history.max_commands*
** description: `maximum number of user commands in history (0 = unlimited)`
** type: integer
** values: 0 .. 2147483647 (default value: `100`)

* *weechat.history.max_lines*
** description: `maximum number of lines in history per buffer (0 = unlimited)`
** type: integer
** values: 0 .. 2147483647 (default value: `4096`)

* *weechat.history.max_visited_buffers*
** description: `maximum number of visited buffers to keep in memory`
** type: integer
** values: 0 .. 1000 (default value: `50`)

* *weechat.look.align_end_of_lines*
** description: `alignment for end of lines (all lines after the first): they are starting under this data (time, buffer, prefix, suffix, message (default))`
** type: integer
** values: time, buffer, prefix, suffix, message (default value: `message`)

* *weechat.look.buffer_notify_default*
** description: `default notify level for buffers (used to tell WeeChat if buffer must be displayed in hotlist or not, according to importance of message): all=all messages (default), message=messages+highlights, highlight=highlights only, none=never display in hotlist`
** type: integer
** values: none, highlight, message, all (default value: `all`)

* *weechat.look.buffer_time_format*
** description: `time format for each line displayed in buffers (see man strftime for date/time specifiers), colors are allowed with format "${color}", for example french time: "${lightblue}%H${white}%M${lightred}%S"`
** type: string
** values: any string (default value: `"%H:%M:%S"`)

* *weechat.look.color_real_white*
** description: `if set, uses real white color, disabled by default for terms with white background (if you never use white background, you should turn on this option to see real white instead of default term foreground color)`
** type: boolean
** values: on, off (default value: `off`)

* *weechat.look.command_chars*
** description: `chars used to determine if input string is a command or not: input must start with one of these chars; the slash ("/") is always considered as command prefix (example: ".$")`
** type: string
** values: any string (default value: `""`)

* *weechat.look.confirm_quit*
** description: `if set, /quit command must be confirmed with extra argument "-yes" (see /help quit)`
** type: boolean
** values: on, off (default value: `off`)

* *weechat.look.day_change*
** description: `display special message when day changes`
** type: boolean
** values: on, off (default value: `on`)

* *weechat.look.day_change_time_format*
** description: `time format for date displayed when day changed`
** type: string
** values: any string (default value: `"%a, %d %b %Y"`)

* *weechat.look.highlight*
** description: `comma separated list of words to highlight (case insensitive comparison, words may begin or end with "*" for partial match)`
** type: string
** values: any string (default value: `""`)

* *weechat.look.highlight_regex*
** description: `regular expression used to check if a message has highlight or not, at least one match in string must be surrounded by word chars (alphanumeric, "-", "_" or "|"), regular expression is case sensitive, example: "FlashCode|flashy"`
** type: string
** values: any string (default value: `""`)

* *weechat.look.hline_char*
** description: `char used to draw horizontal lines, note that empty value will draw a real line with ncurses, but may cause bugs with URL selection under some terminals`
** type: string
** values: any string (default value: `"-"`)

* *weechat.look.hotlist_names_count*
** description: `max number of names in hotlist (0 = no name displayed, only buffer numbers)`
** type: integer
** values: 0 .. 32 (default value: `3`)

* *weechat.look.hotlist_names_length*
** description: `max length of names in hotlist (0 = no limit)`
** type: integer
** values: 0 .. 32 (default value: `0`)

* *weechat.look.hotlist_names_level*
** description: `level for displaying names in hotlist (combination of: 1=join/part, 2=message, 4=private, 8=highlight, for example: 12=private+highlight)`
** type: integer
** values: 1 .. 15 (default value: `12`)

* *weechat.look.hotlist_names_merged_buffers*
** description: `if set, force display of names in hotlist for merged buffers`
** type: boolean
** values: on, off (default value: `off`)

* *weechat.look.hotlist_short_names*
** description: `if set, uses short names to display buffer names in hotlist (start after first '.' in name)`
** type: boolean
** values: on, off (default value: `on`)

* *weechat.look.hotlist_sort*
** description: `hotlist sort type (group_time_asc (default), group_time_desc, group_number_asc, group_number_desc, number_asc, number_desc)`
** type: integer
** values: group_time_asc, group_time_desc, group_number_asc, group_number_desc, number_asc, number_desc (default value: `group_time_asc`)

* *weechat.look.hotlist_unique_numbers*
** description: `keep only unique numbers in hotlist (this applies only on hotlist items where name is NOT displayed after number)`
** type: boolean
** values: on, off (default value: `on`)

* *weechat.look.input_share*
** description: `share commands, text, or both in input for all buffers (there is still local history for each buffer)`
** type: integer
** values: none, commands, text, all (default value: `none`)

* *weechat.look.input_share_overwrite*
** description: `if set and input is shared, always overwrite input in target buffer`
** type: boolean
** values: on, off (default value: `off`)

* *weechat.look.input_undo_max*
** description: `max number of "undo" for command line, by buffer (0 = undo disabled)`
** type: integer
** values: 0 .. 65535 (default value: `32`)

* *weechat.look.item_time_format*
** description: `time format for "time" bar item (see man strftime for date/time specifiers)`
** type: string
** values: any string (default value: `"%H:%M"`)

* *weechat.look.jump_current_to_previous_buffer*
** description: `jump to previous buffer displayed when jumping to current buffer number with /buffer *N (where N is a buffer number), to easily switch to another buffer, then come back to current buffer`
** type: boolean
** values: on, off (default value: `on`)

* *weechat.look.jump_previous_buffer_when_closing*
** description: `jump to previously visited buffer when closing a buffer (if disabled, then jump to buffer number - 1)`
** type: boolean
** values: on, off (default value: `on`)

* *weechat.look.nickmode*
** description: `display nick mode ((half)op/voice) before each nick`
** type: boolean
** values: on, off (default value: `on`)

* *weechat.look.nickmode_empty*
** description: `display space if nick mode is not (half)op/voice`
** type: boolean
** values: on, off (default value: `off`)

* *weechat.look.paste_max_lines*
** description: `max number of lines for paste without asking user (0 = disable this feature)`
** type: integer
** values: 0 .. 2147483647 (default value: `3`)

* *weechat.look.prefix_action*
** description: `prefix for action messages`
** type: string
** values: any string (default value: `" *"`)

* *weechat.look.prefix_align*
** description: `prefix alignment (none, left, right (default))`
** type: integer
** values: none, left, right (default value: `right`)

* *weechat.look.prefix_align_max*
** description: `max size for prefix (0 = no max size)`
** type: integer
** values: 0 .. 128 (default value: `0`)

* *weechat.look.prefix_align_min*
** description: `min size for prefix`
** type: integer
** values: 0 .. 128 (default value: `0`)

* *weechat.look.prefix_align_more*
** description: `display '+' if prefix is truncated`
** type: boolean
** values: on, off (default value: `on`)

* *weechat.look.prefix_buffer_align*
** description: `prefix alignment for buffer name, when many buffers are merged with same number (none, left, right (default))`
** type: integer
** values: none, left, right (default value: `right`)

* *weechat.look.prefix_buffer_align_max*
** description: `max size for buffer name, when many buffers are merged with same number (0 = no max size)`
** type: integer
** values: 0 .. 128 (default value: `0`)

* *weechat.look.prefix_buffer_align_more*
** description: `display '+' if buffer name is truncated (when many buffers are merged with same number)`
** type: boolean
** values: on, off (default value: `on`)

* *weechat.look.prefix_error*
** description: `prefix for error messages`
** type: string
** values: any string (default value: `"=!="`)

* *weechat.look.prefix_join*
** description: `prefix for join messages`
** type: string
** values: any string (default value: `"-->"`)

* *weechat.look.prefix_network*
** description: `prefix for network messages`
** type: string
** values: any string (default value: `"--"`)

* *weechat.look.prefix_quit*
** description: `prefix for quit messages`
** type: string
** values: any string (default value: `"<--"`)

* *weechat.look.prefix_suffix*
** description: `string displayed after prefix`
** type: string
** values: any string (default value: `"|"`)

* *weechat.look.read_marker*
** description: `use a marker (line or char) on buffers to show first unread line`
** type: integer
** values: none, line, dotted-line, char (default value: `dotted-line`)

* *weechat.look.read_marker_always_show*
** description: `always show read marker, even if it is after last buffer line`
** type: boolean
** values: on, off (default value: `off`)

* *weechat.look.save_config_on_exit*
** description: `save configuration file on exit`
** type: boolean
** values: on, off (default value: `on`)

* *weechat.look.save_layout_on_exit*
** description: `save layout on exit (buffers, windows, or both)`
** type: integer
** values: none, buffers, windows, all (default value: `none`)

* *weechat.look.scroll_amount*
** description: `how many lines to scroll by with scroll_up and scroll_down`
** type: integer
** values: 1 .. 2147483647 (default value: `3`)

* *weechat.look.scroll_page_percent*
** description: `percent of screen to scroll when scrolling one page up or down (for example 100 means one page, 50 half-page)`
** type: integer
** values: 1 .. 100 (default value: `100`)

* *weechat.look.search_text_not_found_alert*
** description: `alert user when text sought is not found in buffer`
** type: boolean
** values: on, off (default value: `on`)

* *weechat.look.set_title*
** description: `set title for window (terminal for Curses GUI) with name and version`
** type: boolean
** values: on, off (default value: `on`)

* *weechat.look.time_format*
** description: `time format for dates converted to strings and displayed in messages`
** type: string
** values: any string (default value: `"%a, %d %b %Y %T"`)

* *weechat.network.gnutls_ca_file*
** description: `file containing the certificate authorities ("%h" will be replaced by WeeChat home, "~/.weechat" by default)`
** type: string
** values: any string (default value: `"%h/ssl/CAs.pem"`)

* *weechat.network.gnutls_handshake_timeout*
** description: `timeout (in seconds) for gnutls handshake`
** type: integer
** values: 1 .. 2147483647 (default value: `30`)

* *weechat.plugin.autoload*
** description: `comma separated list of plugins to load automatically at startup, "*" means all plugins found, a name beginning with "!" is a negative value to prevent a plugin from being loaded, names can start or end with "*" to match several plugins (examples: "*" or "*,!lua,!tcl")`
** type: string
** values: any string (default value: `"*"`)

* *weechat.plugin.debug*
** description: `enable debug messages by default in all plugins (option disabled by default, which is highly recommended)`
** type: boolean
** values: on, off (default value: `off`)

* *weechat.plugin.extension*
** description: `standard plugins extension in filename (for example ".so" under Linux or ".dll" under Microsoft Windows)`
** type: string
** values: any string (default value: `".so"`)

* *weechat.plugin.path*
** description: `path for searching plugins ("%h" will be replaced by WeeChat home, "~/.weechat" by default)`
** type: string
** values: any string (default value: `"%h/plugins"`)

* *weechat.plugin.save_config_on_unload*
** description: `save configuration files when unloading plugins`
** type: boolean
** values: on, off (default value: `on`)

* *weechat.startup.command_after_plugins*
** description: `command executed when WeeChat starts, after loading plugins`
** type: string
** values: any string (default value: `""`)

* *weechat.startup.command_before_plugins*
** description: `command executed when WeeChat starts, before loading plugins`
** type: string
** values: any string (default value: `""`)

* *weechat.startup.display_logo*
** description: `display WeeChat logo at startup`
** type: boolean
** values: on, off (default value: `on`)

* *weechat.startup.display_version*
** description: `display WeeChat version at startup`
** type: boolean
** values: on, off (default value: `on`)