default_config.cfg 20.3 KB
Newer Older
1
2
3
# This is the default config for the XMPP client Poezio.
# Comments should be on their own line and NOT at the end
# of a meaningful line.
4
5
6
# Most options are commented in order to not override the
# default value which may have been changed since the time
# the file was copied on setup.
7

8
[Poezio]
9

10
11
12
13
# Jabber identifier. Specify it only if you want to connect using an existing
# account on a server. This is optional and useful only for some features,
# like room administration, nickname registration.
# The 'server' option will be ignored if you specify a JID (Jabber identifier)
14
# It should be in the form nickname@server.tld or nickname@server.tld/resource
15
16
17
18
19
20
jid =

# A password is needed only if you specified a jid. It will be ignored otherwise
# If you leave this empty, the password will be asked at each startup
password =

mathieui's avatar
mathieui committed
21
22
23
24
# A command that will be executed if "password" is not set, e.g. a session password
# manager like secret-tool on gnome, or anything you want
eval_password =

25
26
27
28
# This identifies this client over time with the server, to let it optimise
# offline storage and various other features.
device_id =

mathieui's avatar
mathieui committed
29
30
31
32
33
34
35
36
37
38
# Path to a PEM certificate file to use for certificate authentication
# through SASL External. If set, keyfile MUST be provided as well in
# order to login.
certfile =

# Path to a PEM private key file to use for certificate authentication
# through SASL External. If set, certfile MUST be provided as well in
# order to login.
keyfile =

39
# the nick you will use when joining a room with no associated nick
mathieui's avatar
mathieui committed
40
# If this is empty, the $USER environment variable will be used
41
42
43
44
45
46
47
48
49
50
51
52
53
54
default_nick =

# the rooms you will join automatically on startup, with associated nickname or not
# format : room@server.tld/nickname:room2@server.tld/nickname2
# default_nick will be used if "/nickname" is not specified
rooms =

# a list of words (separated by a colon (:)) that will be
# highlighted if said by someone on a room
highlight_on =

# Colon-separated list of plugins to load on startup
plugins_autoload =

55
56
# The server used for anonymous connection.
# Make sure the server you're using accepts anonymous authentication
57
#server = anon.jeproteste.info
58

59
# TLS Certificate fingerprint
60
61
62
# Do not touch this if you don’t know what you are doing
certificate =

63
64
65
66
# List of ciphers allowed when connecting to the server,
# this list prioritizes forward secrecy and forbids anything
# weaker than 128 bits.
# You should probably leave it as it is
67
#ciphers = HIGH+kEDH:HIGH+kEECDH:HIGH:!PSK:!SRP:!3DES:!aNULL
68
69

# Skip the TLS certificate fingerprint verification
70
# Should be false in most cases, as you want to check that the server keeps
71
# the same certificate.
72
#ignore_certificate = false
73

mathieui's avatar
mathieui committed
74
# Force TLS on by default
75
#force_encryption = true
mathieui's avatar
mathieui committed
76

mathieui's avatar
mathieui committed
77
78
79
# The interval to send a whitespace keepalive to the server
# 300 should be fine, except for specific services, in that case, change the
# value to the services default.
80
#whitespace_interval = 300
mathieui's avatar
mathieui committed
81

mathieui's avatar
mathieui committed
82
83
84
85
86
87
88
# Path to the certificate authenticating the Authority
# A server may have several certificates, but if it uses a CA, it will often
# keep the same for obvious reasons, so this is a good option if your server
# does this, rather than skipping all verifications.
# This is not affected by ignore_certificate
ca_cert_path =

mathieui's avatar
mathieui committed
89
# Auto-reconnects you when you get disconnected from the server
90
#auto_reconnect = true
mathieui's avatar
mathieui committed
91

92
# The time between the ping sent to the server to check if the connection is alive
93
#connection_check_interval = 300
94
95

# The timeout value of those pings
96
#connection_timeout_delay = 30
97

mathieui's avatar
mathieui committed
98
# Send the initial presence
99
# true, unless you want to be invisible from your contact list
100
# warning: this disables any presence sending other than chatrooms or directed
mathieui's avatar
mathieui committed
101
# presences via /presence
102
#send_initial_presence = true
mathieui's avatar
mathieui committed
103

104
105
106
# The status (show) poezio will send when connecting.
# can be: xa,dnd,away,available,chat.
# An empty or invalid value will mean available.
107
#status =
108
109
110
111
112
113

# The status message you will have upon connection
status_message =

# Save the last used status in this file (in the status and status_message
# options)
114
#save_status = true
115

116
117
118
# A custom host that will be used instead of the DNS records for the server
# (anonymous or the jid’s) defined above.
# You should not need this in a "normal" use case.
119
#custom_host =
120
121
122
123

# A custom port to use instead of the 5222.
# This option can be combined with custom_host.
# You should not need this in a "normal" use case.
124
#custom_port =
125

126
# the method that poezio will use to store your bookmarks online
mathieui's avatar
mathieui committed
127
# possible values are: privatexml, pep
128
# You should not have to modify this, but if you have to, please do.
louiz’'s avatar
louiz’ committed
129
use_bookmarks_method =
130

mathieui's avatar
mathieui committed
131
132
# use this option to force the use of local bookmarks
# possible values are: anything/false
133
#use_remote_bookmarks = true
mathieui's avatar
mathieui committed
134

mathieui's avatar
mathieui committed
135
136
# Force the retrieval of the remote bookmarks even when the server
# doesn't advertise support for your method
137
#force_remote_bookmarks = false
mathieui's avatar
mathieui committed
138

mathieui's avatar
mathieui committed
139
140
# Whether you want all bookmarks, even those without
# autojoin, to be open on startup
141
#open_all_bookmarks = false
mathieui's avatar
mathieui committed
142

143
144
# Will create a bookmark on manual /join, using your preferred
# storage method
145
#bookmark_on_join = false
146

147
148
# What will be put after the name, when using autocompletion at the
# beginning of the input. A space will always be added after that
149
#after_completion = ,
150

151
152
# Whether or not to add a space after a completion in the middle of the
# input (not at the start of it)
153
#add_space_after_completion = true
154

155
156
# The maximum length of the nickname that will be displayed in the
# conversation window.
157
#max_nick_length = 25
158

159
# Show the timestamp of each messages, or not
160
#show_timestamps = true
161

162
163
# Allow a message to "correct" another message in the display if
# the sender wants it.
164
#group_corrections = true
165

166
167
# Words that you want to complete on recent words completion,
# separated by a colon (:).
louiz’'s avatar
louiz’ committed
168
# e.g. words = "anticonstitutionnellement:I protest:I like bananas:"
169
#words =
170

louiz’'s avatar
louiz’ committed
171
172
173
# XHTML-IM is an XMPP extension letting users send messages
# containing XHTML and CSS formating. We can use this to make
# colored text for example.
174
#enable_xhtml_im = true
louiz’'s avatar
louiz’ committed
175

176
177
178
179
# If XHTML-IM is enabled, you may want to reject style parsing, to keep
# only semantic elements formatting.
#enable_css_parsing = true

mathieui's avatar
mathieui committed
180
181
182
183
184
# Stream Management (XEP-0198) is an extension designed to improve
# the reliability of XMPP in unreliable network conditions (such
# as mobile networks). It can however increase bandwidth usage.
#enable_smacks = false

185
186
187
188
189
190
191
# Set a number for this setting.
# The join OR status-change notices will be
# displayed according to this number.
# -1: the notices will ALWAYS be displayed
#  0: the notices will NEVER be displayed
#  n: On any other number, the notices will only be displayed
#     if the user involved has talked since the last n seconds
192
# The quit messages will be hidden only if hide_exit_join is 0
193
# if the value is incorrect, -1 is assumed
194
195
196
# Default settings are :
# - all quit and join notices will be displayed
# - status changes won't be displayed unless
197
#   the user talked in the last 2 minutes
198

199
#hide_exit_join = -1
200

201
#hide_status_change = 120
202

203
204
205
206
207
208
209

# Some informational messages (error, a contact getting connected, etc)
# are sometimes added to the information buffer. These settings can make
# it grow temporarly so you can read these information when they appear.

# A list of message types that should make the information buffer grow
# Possible values; error, roster, warning, info, help
210
#information_buffer_popup_on = error roster warning help info
211

212
# A list of message types separated by colons (":") that should be filtered out from the
213
214
215
216
# information buffer.
# Possible values; error, roster, warning, info, help
#information_buffer_type_filter =

217
218
# The time the message will be visible. If the message takes more than
# one line, the popup will stay visible two second per additional lines
219
#popup_time = 4
220

221
222
223
# Whether to hide the list of user in the MultiUserChat tabs or not. Useful
# for example if you want to copy/paste the content of the buffer, or if you
# want to gain space
224
#hide_user_list = false
225

mathieui's avatar
mathieui committed
226
227
228
# A list of words (or sentences) separated by colons (":"). All the
# informational messages (described above) containing at least one of those
# values will not be shown.
229
#filter_info_messages =
230

mathieui's avatar
mathieui committed
231
# Set to 'true' if you want to automatically rejoin the
232
# rooms when you're kicked or banned
233
#autorejoin = false
234

235
236
# Set to the number of seconds before reconnecting when you are kicked
# or banned. No value, 0, or a negative value means you will be reconnected
mathieui's avatar
mathieui committed
237
# instantly. Only effective if autorejoin is set to true.
238
#autorejoin_delay = 5
mathieui's avatar
mathieui committed
239

240
241
242
243
244
245
246
247
248
249
# If you want poezio to join
# the room with an alternative nickname when
# your nickname is already in use in the room you
# wanted to join, put a non-empty value.
# Else, poezio won't join the room
# This value will be added to your nickname to
# create the alternative nickname.
# For example, if you set "_", and wanted to use
# the nickname "john", your alternative nickname
# will be "john_"
250
#alternative_nickname =
251

252
# set to 'true' if you want to save logs of all the messages
253
# in files.
254
#use_log = true
255

256
257
258
# The number of lines to preload in a chat buffer when it opens
# (the lines are preloaded from the log files)
# 0 or a negative value disable that option
259
#load_log = 10
260

261
# If log_dir is not set, logs will be saved in $XDG_DATA_HOME/poezio/logs,
262
# i.e. in ~/.local/share/poezio/logs/. So, you should specify the directory
263
# you want to use instead. This directory will be created if it doesn't exist
264
#log_dir =
265

266
267
# Log the errors poezio encounters in log_dir/errors.log
# A false value disables this option.
268
#log_errors = true
269

mathieui's avatar
mathieui committed
270
271
272
# If plugins_dir is not set, plugins will be loaded from the plugins/ dir in the
# poezio directory, then $XDG_DATA_HOME/poezio/plugins.
# You can specify another directory to use. It will be created if it doesn't exist
273
#plugins_dir =
louiz’'s avatar
louiz’ committed
274

mathieui's avatar
mathieui committed
275
276
# If plugins_conf_dir is not set, plugin configs will be loaded from
# $XDG_CONFIG_HOME/poezio/plugins. You can specify another directory here.
277
#plugins_conf_dir =
mathieui's avatar
mathieui committed
278

279
280
# the full path to the photo (avatar) you want to use
# it should be less than 16Ko
281
282
283
284
# The avatar is not set by default, because it slows
# poezio's startup a little. Uncomment if you want the default avatar

#photo = ../data/poezio_80.png
285

286
287
# If you want to show all the tabs in the Tab bar, even those
# with no activity, set to true. Else, set to false
288
#show_inactive_tabs = true
289

290
291
292
293
294
295
296
297
# If you want to highlight tabs where the contact is typing
# possible values:
# - direct: one-to-one chats
# - private: private chats in chatrooms
# - conversation: chats with contacts or other JIDs
# - muc: chatrooms
# - true: all chat tabs
# - false or anything else: no highlighting
298
#show_composing_tabs = direct
299

300
# Ignore private messages received in chatrooms
301
#ignore_private = false
302

mathieui's avatar
mathieui committed
303
# If you want to show the tab names in the bottom tab bar, set this to true
304
#show_tab_names = false
mathieui's avatar
mathieui committed
305
306

# If you want to disable the numbers in the bottom tab bar, set this to false
307
# If show_tab_names and show_tab_numbers are both false, the numbers will be
mathieui's avatar
mathieui committed
308
# shown
309
#show_tab_numbers = true
mathieui's avatar
mathieui committed
310

311
# Use the contact name, the nick in the chatroom instead of the full JID to
mathieui's avatar
mathieui committed
312
# display the tab if set to true.
313
#use_tab_nicks = true
mathieui's avatar
mathieui committed
314

315
316
317
# If set to false, poezio will first display the bookmark name, or if empty the
# user part of the JID (before the @) when displaying the chatroom tab name.
#show_muc_jid = false
mathieui's avatar
mathieui committed
318

mathieui's avatar
mathieui committed
319
320
# If this option is set to false, the contact list will not show the contact
# JIDs when that is possible.
mathieui's avatar
mathieui committed
321
322
# e.g. instead of: toto (toto@example.org) (2)
# poezio will only show: toto (2)
323
#show_roster_jids = true
mathieui's avatar
mathieui committed
324

325
# Show JIDs in conversation tabs
326
#show_jid_in_conversations = true
327

mathieui's avatar
mathieui committed
328
# show s2s errors in the contact list
329
#show_s2s_errors = true
330

mathieui's avatar
mathieui committed
331
# If set to true, the contact list will display offline contacts too
332
#roster_show_offline = false
mathieui's avatar
mathieui committed
333

mathieui's avatar
mathieui committed
334
# How to sort the contacts inside the contact list groups.
335
336
337
338
339
# They are used sequentially, (from left to right)
# Available sorting methods are:
#   - reverse: reverse the sorting
#   - jid: sort by JID (alphabetical order)
#   - show: sort by show (available/away/xa/…)
mathieui's avatar
mathieui committed
340
#   - name: sort by name (if no name, then the bare jid is used)
341
#   - sname: case-sensitive name sorting (uppercase first)
342
#   - resource: sort by resource number
343
#   - online: sort by online presence (online or not)
344
# You can arrange them however you like, and you have to separate them with
345
346
# colons (":"). Keep in mind that if there are more than 3 or 4 your
# sorting is most likely inefficient.
347
#roster_sort = jid:show
348

mathieui's avatar
mathieui committed
349
# How to sort the contact list groups.
350
351
352
353
# The principles are the same as roster_sort.
# Available methods are:
#   - reverse: reverse the sorting
#   - name: sort by group name (alphabetical order)
354
#   - sname: case-sensitive name sorting (uppercase first)
355
356
357
358
#   - fold: sort unfolded/folded
#   - connected: sort by number of connected contacts
#   - size: sort by group size
#   - none: put the "none" group (if any) at the end of the list
359
#roster_group_sort = name
360

361
362
363
# The terminal can beep on various event. Put the event you want in a list
# (separated by spaces).
# The events can be
364
# - highlight (when you are highlighted in a chatroom)
365
# - private (when a new private message is received, from your contacts or
366
367
368
#            someone from a chatroiom)
# - message (any message from a chatroom)
# - invite (when you receive an invitation for joining a chatroom)
369
#beep_on = highlight private invite disconnect
370

371
372
373
# Theme

# If themes_dir is not set, logs will searched for in $XDG_DATA_HOME/poezio/themes,
374
# i.e. in ~/.local/share/poezio/themes/. So you should specify the directory you
375
376
# want to use instead. This directory will be created at startup if it doesn't
# exist
377
#themes_dir =
378
379
380
381
382

# The name of the theme file that will be used. The file should be located
# in the theme_dir directory.
# If the file is not found (or no filename is specified) the default
# theme will be used instead
383
#theme = default
384

mathieui's avatar
mathieui committed
385
386
387
# Whether to create gaps when moving or closing a tab
# (a gap means that the number of your tabs does not depend of the previous tabs
# but only of the creation order)
388
#create_gaps = false
mathieui's avatar
mathieui committed
389

390
391
# If Alt-x is pressed and you are already on the tab numbered "x",
# you will go on the previous tab if that option is true
392
#go_to_previous_tab_on_alt_number = false
393

394
395
396
397
# If true, a vertical list of tabs, with their name, is displayed on the left
# of the screen.  Otherwise, it is a horizontal bar with just the tab numbers
# above the input bar.
#enable_vertical_tab_list = true
louiz’'s avatar
louiz’ committed
398

399
# Horizontal size of the vertical tab list
400
#vertical_tab_list_size = 20
louiz’'s avatar
louiz’ committed
401

mathieui's avatar
mathieui committed
402
403
# If set to desc, the tabs will be displayed from top to bottom in the list,
# if set to asc, they will be displayed from bottom to top.
404
#vertical_tab_list_sort = desc
405

406
# Show the user list at the bottom when in a chatroom
407
408
# (useful when you want to look at the bottom of the screen only)
# possible values: desc, asc
409
#user_list_sort = desc
410

411
# If the chatroom nicks should receive a fixed color based on their text or not
412
#deterministic_nick_colors = true
413

414
# If _nick, nick_, _nick_, nick__ etc. should have the same color as nick
415
#nick_color_aliases = true
416

417
418
# The nick of people who join, part, change their status, etc. in a chatroom
# will be displayed using their nick color if true.
419
#display_user_color_in_join_part = true
420

mathieui's avatar
mathieui committed
421
# Display user tune notifications as information messages or not
422
#display_tune_notifications = false
mathieui's avatar
mathieui committed
423

424
# Change the tab state when receiving chatroom messages.
425
426
427
# useful if you are connected to a high-volume chatroom and do not
# want it to appear in your tab bar as active. Highlights are still
# shown.
428
#notify_messages = true
429

mathieui's avatar
mathieui committed
430
431
# Enable Message Carbons (XEP-0280) to deliver message copies from and to
# other resources with carbons enabled.
432
#enable_carbons = true
mathieui's avatar
mathieui committed
433

434
# Acknowledge message delivery receipts (XEP-0184)
435
#ack_message_receipts = true
436
437

# Ask for message delivery receipts (XEP-0184)
438
#request_message_receipts = true
439

440
# Display your contacts’ avatar in the roster if true.
441
#enable_avatars = true
442

443
444
445
446
447
# Use Unicode half-block (▄) instead of full-block (█) to display images.
# This doubles the vertical resolution and gives square pixels, but may
# cause issues in some terminals.
#image_use_half_blocks = false

448
449
# Extract base64 images received in XHTML-IM messages
# if true.
450
#extract_inline_images = true
451
452
453

# The directory where the images will be saved; if unset,
# defaults to $XDG_CACHE_HOME/poezio/images.
454
#tmp_image_dir =
455

mathieui's avatar
mathieui committed
456
457
# Receive the tune notifications or not (in order to display information
# in the contact list).
458
459
# If this is set to false, then the display_tune_notifications
# option will be ignored.
460
#enable_user_tune = true
mathieui's avatar
mathieui committed
461

mathieui's avatar
mathieui committed
462
# Display user gaming notifications as information messages or not
463
#display_gaming_notifications = false
mathieui's avatar
mathieui committed
464

mathieui's avatar
mathieui committed
465
466
# Receive the gaming notifications or not (in order to display information
# in the contact list).
mathieui's avatar
mathieui committed
467
468
# If this is set to false, then the display_gaming_notifications
# option will be ignored.
469
#enable_user_gaming = true
mathieui's avatar
mathieui committed
470

mathieui's avatar
mathieui committed
471
# Display user mood notifications as information messages or not
472
#display_mood_notifications = false
mathieui's avatar
mathieui committed
473

mathieui's avatar
mathieui committed
474
475
# Receive the mood notifications or not (in order to display information
# in the contact list).
mathieui's avatar
mathieui committed
476
477
# If this is set to false, then the display_mood_notifications
# option will be ignored.
478
#enable_user_mood = true
mathieui's avatar
mathieui committed
479
480

# Display user activity notifications as information messages or not
481
#display_activity_notifications = false
mathieui's avatar
mathieui committed
482

mathieui's avatar
mathieui committed
483
484
# Receive the activity notifications or not (in order to display information
# in the contact list).
mathieui's avatar
mathieui committed
485
486
# If this is set to false, then the display_activity_notifications
# option will be ignored.
487
#enable_user_activity = true
488

mathieui's avatar
mathieui committed
489
490
# If set to true, use the nickname broadcasted by the user if none has been
# set manually.
491
#enable_user_nick = true
mathieui's avatar
mathieui committed
492

493
494
495
496
497
498
# if true, chat states will be sent to the people you are talking to.
# Chat states are, for example, messages informing that you are composing
# a message or that you closed the tab, etc
# Set to false if you don't want people to know these information
# Note that you won’t receive the chat states of your contacts
# if you don't send yours.
499
#send_chat_states = true
500

501
# if true, information about the software (name and version)
502
503
# will be sent if requested by anyone
# Set to false if you don't want people to know these information
504
#send_poezio_info = true
505
506

# if true, information about the Operation System you're using
507
508
# will be sent when requested by anyone
# Set to false if you don't want people to know these information
509
# Note that this information will not be sent if send_poezio_info is False
510
#send_os_info = true
511
512
513

# if true, your current time will be sent if asked
# Set to false if you don't want people to know that information
514
#send_time = true
515

516
517
# If true, the history of the similar inputs won't be shared between
# different tabs (as in weechat).
518
#separate_history = false
519

mathieui's avatar
mathieui committed
520
# The language you specify using.
521
# This *may* be used by an automated entity to send you tailored replies
mathieui's avatar
mathieui committed
522
# If you don't understand, leave en.
523
#lang = en
mathieui's avatar
mathieui committed
524

525
526
527
# Configure the number of maximum lines and messages (for each tab) that
# can be kept in memory. If poezio consumes too much memory, lower these
# values
528
529
#max_messages_in_memory = 2048
#max_lines_in_memory = 2048
530

531
532
# Show the separator at the bottom of the text buffer, even if no one
# spoke
533
#show_useless_separator = true
534

mathieui's avatar
mathieui committed
535
536
537
# Set this to true if you want the commands to be executed remotely
# (with ssh & the daemon), see the documentation of the /link plugin
# for details
538
#exec_remote = false
mathieui's avatar
mathieui committed
539
540

# Path of the FIFO in which the remote commands will be sent.
541
# The "poezio.fifo" file will be created in this directory
mathieui's avatar
mathieui committed
542
# Used with exec_remote set to true, see the documentation of /link for details
543
# Defaults to ./
544
#remote_fifo_path = ./
mathieui's avatar
mathieui committed
545

546
547
548
# Defines if all tabs are resized at the same time (if set to false)
# or if they are really resized only when needed (if set to true).
# “true” should be the most comfortable value
549
#lazy_resize = true
550

551
552
553
554
555
556
557
# If set to true and if show_tab_names is set, the info bar will only show
# the unique prefix of each tab name instead of the full name. This saves a
# lot of space if many tabs exist or are active.
# Best used with the `/wup` command or the `_go_to_room_name` action to select
# a tab based on the prefix.
#unique_prefix_tab_names = false

louiz’'s avatar
louiz’ committed
558
559
560
[bindings]
# Bindings are keyboard shortcut aliases. You can use them
# to define your own keys and bind them with some functions
561
# The syntax is
louiz’'s avatar
louiz’ committed
562
563
564
565
566
567
#    key = bind
# where ^x means Control + x
# and M-x means Alt + x
# The example turns Alt + i into a tab key
M-i = ^I

568
569
570
[var]
# You should not edit this section, it is just used by poezio
# to save various data across restarts
571
572
folded_roster_groups =
info_win_height = 2
573
574
575
576

[muc_colors]
# Set color for a nick, under the form
# nick = color