default_config.cfg 19.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 25
# 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 =

mathieui's avatar
mathieui committed
26 27 28 29 30 31 32 33 34 35
# 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 =

36
# the nick you will use when joining a room with no associated nick
mathieui's avatar
mathieui committed
37
# If this is empty, the $USER environment variable will be used
38 39 40 41 42 43 44 45 46 47 48 49 50 51
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 =

52 53
# The server used for anonymous connection.
# Make sure the server you're using accepts anonymous authentication
54
#server = anon.jeproteste.info
55

56
# TLS Certificate fingerprint
57 58 59
# Do not touch this if you don’t know what you are doing
certificate =

60 61 62 63
# 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
64
#ciphers = HIGH+kEDH:HIGH+kEECDH:HIGH:!PSK:!SRP:!3DES:!aNULL
65 66

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

mathieui's avatar
mathieui committed
71
# Force TLS on by default
72
#force_encryption = true
mathieui's avatar
mathieui committed
73

mathieui's avatar
mathieui committed
74 75 76
# 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.
77
#whitespace_interval = 300
mathieui's avatar
mathieui committed
78

mathieui's avatar
mathieui committed
79 80 81 82 83 84 85
# 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
86
# Auto-reconnects you when you get disconnected from the server
87
#auto_reconnect = true
mathieui's avatar
mathieui committed
88

89
# The time between the ping sent to the server to check if the connection is alive
90
#connection_check_interval = 300
91 92

# The timeout value of those pings
93
#connection_timeout_delay = 30
94

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

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

# 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)
111
#save_status = true
112

113 114 115
# 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.
116
#custom_host =
117 118 119 120

# 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.
121
#custom_port =
122

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

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

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

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

140 141
# What will be put after the name, when using autocompletion at the
# beginning of the input. A space will always be added after that
142
#after_completion = ,
143

144 145
# Whether or not to add a space after a completion in the middle of the
# input (not at the start of it)
146
#add_space_after_completion = true
147

148 149
# The maximum length of the nickname that will be displayed in the
# conversation window.
150
#max_nick_length = 25
151

152
# Show the timestamp of each messages, or not
153
#show_timestamps = true
154

155 156
# Allow a message to "correct" another message in the display if
# the sender wants it.
157
#group_corrections = true
158

159 160
# Words that you want to complete on recent words completion,
# separated by a colon (:).
louiz’'s avatar
louiz’ committed
161
# e.g. words = "anticonstitutionnellement:I protest:I like bananas:"
162
#words =
163

louiz’'s avatar
louiz’ committed
164 165 166
# 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.
167
#enable_xhtml_im = true
louiz’'s avatar
louiz’ committed
168

mathieui's avatar
mathieui committed
169 170 171 172 173
# 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

174 175 176 177 178 179 180
# 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
181
# The quit messages will be hidden only if hide_exit_join is 0
182
# if the value is incorrect, -1 is assumed
183 184 185
# Default settings are :
# - all quit and join notices will be displayed
# - status changes won't be displayed unless
186
#   the user talked in the last 2 minutes
187

188
#hide_exit_join = -1
189

190
#hide_status_change = 120
191

192 193 194 195 196 197 198

# 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
199
#information_buffer_popup_on = error roster warning help info
200

201
# A list of message types separated by colons (":") that should be filtered out from the
202 203 204 205
# information buffer.
# Possible values; error, roster, warning, info, help
#information_buffer_type_filter =

206 207
# 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
208
#popup_time = 4
209

210 211 212
# 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
213
#hide_user_list = false
214

mathieui's avatar
mathieui committed
215 216 217
# 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.
218
#filter_info_messages =
219

mathieui's avatar
mathieui committed
220
# Set to 'true' if you want to automatically rejoin the
221
# rooms when you're kicked or banned
222
#autorejoin = false
223

224 225
# 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
226
# instantly. Only effective if autorejoin is set to true.
227
#autorejoin_delay = 5
mathieui's avatar
mathieui committed
228

229 230 231 232 233 234 235 236 237 238
# 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_"
239
#alternative_nickname =
240

241
# set to 'true' if you want to save logs of all the messages
242
# in files.
243
#use_log = false
244

245 246 247
# 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
248
#load_log = 10
249

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

255 256
# Log the errors poezio encounters in log_dir/errors.log
# A false value disables this option.
257
#log_errors = true
258

mathieui's avatar
mathieui committed
259 260 261
# 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
262
#plugins_dir =
louiz’'s avatar
louiz’ committed
263

mathieui's avatar
mathieui committed
264 265
# If plugins_conf_dir is not set, plugin configs will be loaded from
# $XDG_CONFIG_HOME/poezio/plugins. You can specify another directory here.
266
#plugins_conf_dir =
mathieui's avatar
mathieui committed
267

268 269
# the full path to the photo (avatar) you want to use
# it should be less than 16Ko
270 271 272 273
# 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
274

275 276
# If you want to show all the tabs in the Tab bar, even those
# with no activity, set to true. Else, set to false
277
#show_inactive_tabs = true
278

279 280 281 282 283 284 285 286
# 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
287
#show_composing_tabs = direct
288

289
# Ignore private messages received in chatrooms
290
#ignore_private = false
291

mathieui's avatar
mathieui committed
292
# If you want to show the tab names in the bottom tab bar, set this to true
293
#show_tab_names = false
mathieui's avatar
mathieui committed
294 295

# If you want to disable the numbers in the bottom tab bar, set this to false
296
# If show_tab_names and show_tab_numbers are both false, the numbers will be
mathieui's avatar
mathieui committed
297
# shown
298
#show_tab_numbers = true
mathieui's avatar
mathieui committed
299

300
# Use the contact name, the nick in the chatroom instead of the full JID to
mathieui's avatar
mathieui committed
301
# display the tab if set to true.
302
#use_tab_nicks = true
mathieui's avatar
mathieui committed
303 304

# If set to false, poezio will only display the user part of the JID (before
305
# the @) when displaying the chatroom tab name.
306
#show_muc_jid = true
mathieui's avatar
mathieui committed
307

mathieui's avatar
mathieui committed
308 309
# 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
310 311
# e.g. instead of: toto (toto@example.org) (2)
# poezio will only show: toto (2)
312
#show_roster_jids = true
mathieui's avatar
mathieui committed
313

314
# Show JIDs in conversation tabs
315
#show_jid_in_conversations = true
316

mathieui's avatar
mathieui committed
317
# show s2s errors in the contact list
318
#show_s2s_errors = true
319

mathieui's avatar
mathieui committed
320
# If set to true, the contact list will display offline contacts too
321
#roster_show_offline = false
mathieui's avatar
mathieui committed
322

mathieui's avatar
mathieui committed
323
# How to sort the contacts inside the contact list groups.
324 325 326 327 328
# 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
329
#   - name: sort by name (if no name, then the bare jid is used)
330
#   - sname: case-sensitive name sorting (uppercase first)
331
#   - resource: sort by resource number
332
#   - online: sort by online presence (online or not)
333
# You can arrange them however you like, and you have to separate them with
334 335
# colons (":"). Keep in mind that if there are more than 3 or 4 your
# sorting is most likely inefficient.
336
#roster_sort = jid:show
337

mathieui's avatar
mathieui committed
338
# How to sort the contact list groups.
339 340 341 342
# The principles are the same as roster_sort.
# Available methods are:
#   - reverse: reverse the sorting
#   - name: sort by group name (alphabetical order)
343
#   - sname: case-sensitive name sorting (uppercase first)
344 345 346 347
#   - 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
348
#roster_group_sort = name
349

350 351 352
# The terminal can beep on various event. Put the event you want in a list
# (separated by spaces).
# The events can be
353
# - highlight (when you are highlighted in a chatroom)
354
# - private (when a new private message is received, from your contacts or
355 356 357
#            someone from a chatroiom)
# - message (any message from a chatroom)
# - invite (when you receive an invitation for joining a chatroom)
358
#beep_on = highlight private invite disconnect
359

360 361 362
# Theme

# If themes_dir is not set, logs will searched for in $XDG_DATA_HOME/poezio/themes,
363
# i.e. in ~/.local/share/poezio/themes/. So you should specify the directory you
364 365
# want to use instead. This directory will be created at startup if it doesn't
# exist
366
#themes_dir =
367 368 369 370 371

# 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
372
#theme = default
373

mathieui's avatar
mathieui committed
374 375 376
# 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)
377
#create_gaps = false
mathieui's avatar
mathieui committed
378

379 380
# 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
381
#go_to_previous_tab_on_alt_number = false
382

mathieui's avatar
mathieui committed
383 384
# If true, a vertical list of tabs, with their name, is displayed on the left of
# the screen.
385
#enable_vertical_tab_list = false
louiz’'s avatar
louiz’ committed
386

387
# Horizontal size of the vertical tab list
388
#vertical_tab_list_size = 20
louiz’'s avatar
louiz’ committed
389

mathieui's avatar
mathieui committed
390 391
# 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.
392
#vertical_tab_list_sort = desc
393

394
# Show the user list at the bottom when in a chatroom
395 396
# (useful when you want to look at the bottom of the screen only)
# possible values: desc, asc
397
#user_list_sort = desc
398

399
# If the chatroom nicks should receive a fixed color based on their text or not
400
#deterministic_nick_colors = true
401

402
# If _nick, nick_, _nick_, nick__ etc. should have the same color as nick
403
#nick_color_aliases = true
404

405 406
# The nick of people who join, part, change their status, etc. in a chatroom
# will be displayed using their nick color if true.
407
#display_user_color_in_join_part = true
408

mathieui's avatar
mathieui committed
409
# Display user tune notifications as information messages or not
410
#display_tune_notifications = false
mathieui's avatar
mathieui committed
411

412
# Change the tab state when receiving chatroom messages.
413 414 415
# 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.
416
#notify_messages = true
417

mathieui's avatar
mathieui committed
418 419
# Enable Message Carbons (XEP-0280) to deliver message copies from and to
# other resources with carbons enabled.
420
#enable_carbons = true
mathieui's avatar
mathieui committed
421

422
# Acknowledge message delivery receipts (XEP-0184)
423
#ack_message_receipts = true
424 425

# Ask for message delivery receipts (XEP-0184)
426
#request_message_receipts = true
427

428 429 430
# Display your contacts’ avatar in the roster if true.
#enable_avatars = true

431 432
# Extract base64 images received in XHTML-IM messages
# if true.
433
#extract_inline_images = true
434 435 436

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

mathieui's avatar
mathieui committed
439 440
# Receive the tune notifications or not (in order to display information
# in the contact list).
441 442
# If this is set to false, then the display_tune_notifications
# option will be ignored.
443
#enable_user_tune = true
mathieui's avatar
mathieui committed
444

mathieui's avatar
mathieui committed
445
# Display user gaming notifications as information messages or not
446
#display_gaming_notifications = false
mathieui's avatar
mathieui committed
447

mathieui's avatar
mathieui committed
448 449
# Receive the gaming notifications or not (in order to display information
# in the contact list).
mathieui's avatar
mathieui committed
450 451
# If this is set to false, then the display_gaming_notifications
# option will be ignored.
452
#enable_user_gaming = true
mathieui's avatar
mathieui committed
453

mathieui's avatar
mathieui committed
454
# Display user mood notifications as information messages or not
455
#display_mood_notifications = false
mathieui's avatar
mathieui committed
456

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

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

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

mathieui's avatar
mathieui committed
472 473
# If set to true, use the nickname broadcasted by the user if none has been
# set manually.
474
#enable_user_nick = true
mathieui's avatar
mathieui committed
475

476 477 478 479 480 481
# 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.
482
#send_chat_states = true
483

484
# if true, information about the software (name and version)
485 486
# will be sent if requested by anyone
# Set to false if you don't want people to know these information
487
#send_poezio_info = true
488 489

# if true, information about the Operation System you're using
490 491
# will be sent when requested by anyone
# Set to false if you don't want people to know these information
492
# Note that this information will not be sent if send_poezio_info is False
493
#send_os_info = true
494 495 496

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

499 500
# If true, the history of the similar inputs won't be shared between
# different tabs (as in weechat).
501
#separate_history = false
502

mathieui's avatar
mathieui committed
503
# The language you specify using.
504
# This *may* be used by an automated entity to send you tailored replies
mathieui's avatar
mathieui committed
505
# If you don't understand, leave en.
506
#lang = en
mathieui's avatar
mathieui committed
507

508 509 510
# 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
511 512
#max_messages_in_memory = 2048
#max_lines_in_memory = 2048
513

514 515
# Show the separator at the bottom of the text buffer, even if no one
# spoke
516
#show_useless_separator = true
517

mathieui's avatar
mathieui committed
518 519 520
# 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
521
#exec_remote = false
mathieui's avatar
mathieui committed
522 523

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

529 530 531
# 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
532
#lazy_resize = true
533

louiz’'s avatar
louiz’ committed
534 535 536
[bindings]
# Bindings are keyboard shortcut aliases. You can use them
# to define your own keys and bind them with some functions
537
# The syntax is
louiz’'s avatar
louiz’ committed
538 539 540 541 542 543
#    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

544 545 546
[var]
# You should not edit this section, it is just used by poezio
# to save various data across restarts
547 548
folded_roster_groups =
info_win_height = 2
549 550 551 552

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