configuration.rst 34.5 KB
Newer Older
mathieui's avatar
mathieui committed
1
2
.. _config:

mathieui's avatar
mathieui committed
3
4
Configuration
=============
mathieui's avatar
mathieui committed
5

mathieui's avatar
mathieui committed
6
The configuration is located in the file ``~/.config/poezio/poezio.cfg``
mathieui's avatar
mathieui committed
7
8
9
10
On its first startup, poezio will create that file (and its containing
directories) with the default configuration. You can edit that file manually
or use the :term:`/set` command to edit some of its values directly from poezio.
This file is also used to configure key bindings, but this is explained
mathieui's avatar
mathieui committed
11
in the :ref:`keys-page` documentation file.
mathieui's avatar
mathieui committed
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

That file is read at each startup and the configuration is saved when poezio
is closed.

This configuration file **requires** all global options to be in a section
named [Poezio]. Some other options can be in optional sections and will
apply only to tabs having the option’s name.

An option is formatted like this:

``option = value``

An empty value *doesn’t* mean that the default value will be used. That’s
just an empty value. To use the default value, just comment or remove the
option entirely.

Here is a list of all the available configuration options, their meaning
and their default value.

Global section options
mathieui's avatar
mathieui committed
32
----------------------
mathieui's avatar
mathieui committed
33
34
35
36
37

These options have a sense when they are in the global section. Some of
them can also be in an optional configuration section, see the next
section of this documentation.

mathieui's avatar
mathieui committed
38
39
The options here are separated thematically for convenience but they all
go into the main config section.
mathieui's avatar
mathieui committed
40
41


mathieui's avatar
mathieui committed
42
43
Security
~~~~~~~~
mathieui's avatar
mathieui committed
44

mathieui's avatar
mathieui committed
45
46
Options pertaining to security, such as :ref:`TLS encryption <security settings>`
and certificate validation.
mathieui's avatar
mathieui committed
47

mathieui's avatar
mathieui committed
48
49
.. glossary::
    :sorted:
mathieui's avatar
mathieui committed
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

    ca_cert_path

        **Default value:** ``[empty]``

        Path to the certificate of the Certification Authority.
        As some services may keep different certificates, it is an alternative to
        the Trust On First Use model provided by the :term:`certificate` option.
        This option is not affected by :term:`ignore_certificate` and boths checks
        may be active at the same time.

    certificate

        **Default value:** ``[empty]``

65
66
67
68
69
        The SHA-2 fingerprint of the SSL certificate as a hexadecimal string,
        you should not touch it, except if know what you are doing.

        .. note:: the fingerprint was previously stored in SHA-1, and has been
                silently upgraded to SHA-2 if the SHA-1 still matched.
mathieui's avatar
mathieui committed
70

71
72
73
74
75
76
77
78
    ciphers

        **Default value:** ``HIGH+kEDH:HIGH+kEECDH:HIGH:!PSK:!SRP:!3DES:!aNULL``

        The TLS cipher suites allowed, in `OpenSSL format`_. Modify this if
        you know what you are doing, see the :ref:`ciphers` dedicated section
        for more details.

mathieui's avatar
mathieui committed
79
    force_encryption
80

mathieui's avatar
mathieui committed
81
        **Default value:** ``true``
82

mathieui's avatar
mathieui committed
83
84
85
        If set to true, all connections will use TLS by default. Only turn this to
        false if you cannot connect to your server, and do not care about your password
        or the pricacy of your communications.
86

mathieui's avatar
mathieui committed
87
    ignore_certificate
88

mathieui's avatar
mathieui committed
89
        **Default value:** ``false``
90

mathieui's avatar
mathieui committed
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
        Skip certificate validation on connection when ``true``. Useful when you are in
        anonymous mode and changing servers often. Dangerous in other cases, from a
        security perspective.



Account
~~~~~~~

Options related to account configuration, nickname…

.. glossary::
    :sorted:

    jid

        **Default value:** ``[empty]``

        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 or nickname registration.
        The :term:`server` option will be ignored if you specify a JID (Jabber id)
        It should be in the form nickname@server.tld
114

mathieui's avatar
mathieui committed
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
    custom_host

        **Default value:** ``[empty]``

        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.

    custom_port

        **Default value:** ``[empty]``

        A custom port to use instead of the ``5222``.
        This option can be combined with :term:`custom_host`.
        You should not need this in a "normal" use case.

    default_nick

        **Default value:** ``[empty]``

        the nick you will use when joining a room with no associated nick
        If this is empty, the $USER environnement variable will be used

mathieui's avatar
mathieui committed
138
    server
mathieui's avatar
mathieui committed
139

mathieui's avatar
mathieui committed
140
        **Default value:** ``anon.jeproteste.info``
mathieui's avatar
mathieui committed
141

mathieui's avatar
mathieui committed
142
143
        The server to use for anonymous authentication;
        make sure it supports anonymous authentification.
mathieui's avatar
mathieui committed
144

mathieui's avatar
mathieui committed
145
        Note that this option doesn’t do anything at all if you’re using your own JID.
mathieui's avatar
mathieui committed
146

mathieui's avatar
mathieui committed
147
    alternative_nickname
mathieui's avatar
mathieui committed
148

mathieui's avatar
mathieui committed
149
        **Default value:** ``[empty]``
mathieui's avatar
mathieui committed
150

mathieui's avatar
mathieui committed
151
152
153
154
155
156
        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. If you don’t, 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\_".
mathieui's avatar
mathieui committed
157
158


mathieui's avatar
mathieui committed
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
    keyfile

        **Default value:** ``[empty]``

        Path to a PEM private key file to use for certificate authentication
        through SASL External. If set, :term:`certfile` **MUST** be set as well
        in order to login.

    certfile

        **Default value:** ``[empty]``

        Path to a PEM certificate file to use for certificate authentication
        through SASL External. If set, :term:`keyfile` **MUST** be set as well
        in order to login.

mathieui's avatar
mathieui committed
175
    resource
mathieui's avatar
mathieui committed
176

mathieui's avatar
mathieui committed
177
        **Default value:** ``[empty]``
mathieui's avatar
mathieui committed
178

mathieui's avatar
mathieui committed
179
180
181
        The resource you will use. If it's empty, your resource will be chosen
        (most likely randomly) by the server. It is not recommended to use a
        resource that is easy to guess, because it can lead to presence leak.
mathieui's avatar
mathieui committed
182

mathieui's avatar
mathieui committed
183
    rooms
mathieui's avatar
mathieui committed
184

mathieui's avatar
mathieui committed
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
        **Default value:** ``[empty]``

        The rooms you will join automatically on startup, with associated
        nickname or not.

        Format : ``room@server.tld/nickname:room2@server.tld/nickname2``.

        The :term:`default_nick` option will be used if "/nickname" is not specified.

    password

        **Default value:** ``[empty]``

        A password is needed only if you specified a :term:`jid`. It will be ignored otherwise
        If you leave this empty, the password will be asked at each startup, which is recommended.

    status

        **Default value:** ``[empty]``

        The status (show) poezio will send when connecting. It can be available,
        ``dnd``, ``chat``, ``xa`` or ``away``.

        Nothing or an invalid value will mean available.

    status_message

        **Default value:** ``[empty]``

        The status message poezio will send when connecting.

mathieui's avatar
mathieui committed
216
217
218
219
220
221
222
    open_all_bookmarks

        **Default value:** ``false``

        If this option is set to ``true``, all remote bookmarks, even
        those that do not have autojoin, will be opened on startup.
        (the tabs without autojoin will not be joined)
mathieui's avatar
mathieui committed
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237



Connectivity

~~~~~~~~~~~~

Options about general or chatroom connectivity. Reconnecting does not work very
well, but you will at least want to know when you get disconnected.


.. glossary::
    :sorted:

    auto_reconnect
mathieui's avatar
mathieui committed
238

239
        **Default value:** ``true``
mathieui's avatar
mathieui committed
240

241
242
        Auto-reconnects you when you get disconnected from the
        server. Poezio will try to reconnect forever, until it succeeds.
mathieui's avatar
mathieui committed
243

mathieui's avatar
mathieui committed
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
    connection_check_interval

        **Default value:** ``60``

        A ping is sent to the server every N seconds, N being the value of
        that option.  Change this to a low value if you want to know quickly
        when you are disconnected, and to a very high value if bandwidth
        matters so much that you can’t afford 100 bytes/minute, or if you
        don’t want to waste your battery by waking up the TCP connection too
        often.  Disable this ping altogether by setting this value to 0.

    connection_timeout_delay

        **Default value:** ``10``

        The timeout delay of the ping referenced above, 10 should really be fine, but
        if your network is really unstable, it can be set higher or lower, depending
        of your preference.

    whitespace_interval

        **Default value:** ``300``

        Interval of the whitespace keepalive sending to the server.
        ``300`` should be fine, but change it if some services have a stricter policy
        on client inactivity.

    autorejoin
mathieui's avatar
mathieui committed
272
273
274

        **Default value:** ``false``

mathieui's avatar
mathieui committed
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
        Set to true if you want to automatically rejoin the room when you're kicked.

    autorejoin_delay

        **Default value:** ``5``

        Set to the number of seconds before reconnecting after getting kicked.
        0, a negative value, or no value means you reconnect instantly.
        This option only works if autorejoin is enabled.


XMPP features
~~~~~~~~~~~~~

These options enable, disable, or allow to configure the behavior
of some non-essential XMPP features. There is a dedicated page
to understand what is :ref:`carbons <carbons-details>` or
:ref:`user activity/gaming/mood/tune <pep-details>`.

.. glossary::
    :sorted:
mathieui's avatar
mathieui committed
296

mathieui's avatar
mathieui committed
297
298
299
300
301
302
303
    enable_carbons

        **Default value:** ``false``

        Set this to ``true`` to enable Message Carbons (XEP-280), which allows transparent message
        delivery from and to other resources with carbons enabled.

mathieui's avatar
mathieui committed
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
    enable_user_activity

        **Default value:** ``true``

        Set this to ``false`` if you don’t want to receive the activity of your contacts.

    enable_user_gaming

        **Default value:** ``true``

        Set this to ``false`` if you don’t want to receive the gaming activity of your contacts.

    enable_user_mood

        **Default value:** ``true``

        Set this to ``false`` if you don’t want to receive the mood of your contacts.

    enable_user_nick

        **Default value:** ``true``

        Set to ``false`` if you don’t want your contacts to hint you their identity.

    enable_user_tune

        **Default value:** ``true``

        If this is set to ``false``, you will no longer be subscribed to tune events,
        and the :term:`display_tune_notifications` option will be ignored.

335
336
337
338
339
340
341
342
    go_to_previous_tab_on_alt_number

       **Default value:** ``false``

       If this is set to ``true``, when Alt+x is pressed, where x is a
       number, if you are already on the tab number x, you will jump to the
       previously selected tab. Otherwise you’ll stay on the same tab.

343
344
345
346
347
348
349
350
    group_corrections

        **Default value:** ``true``

        Enable a message to “correct” (replace) another message in the display if the
        sender intended it as such. See :ref:`Message Correction <correct-feature>` for
        more information.

mathieui's avatar
mathieui committed
351
    use_bookmark_method
mathieui's avatar
mathieui committed
352

mathieui's avatar
mathieui committed
353
        **Default value:** ``[empty]``
mathieui's avatar
mathieui committed
354

mathieui's avatar
mathieui committed
355
356
357
        The method that poezio will use to store your bookmarks online.
        Possible values are: ``privatexml``, ``pep``.
        You should not have to edit this in a normal use case.
mathieui's avatar
mathieui committed
358

mathieui's avatar
mathieui committed
359
    use_pep_nick
mathieui's avatar
mathieui committed
360
361
362

        **Default value:** ``true``

mathieui's avatar
mathieui committed
363
364
        Use the nickname broadcasted by the user if set to ``true``, and if none
        has already been set manually.
mathieui's avatar
mathieui committed
365

mathieui's avatar
mathieui committed
366
    use_remote_bookmarks
mathieui's avatar
mathieui committed
367

mathieui's avatar
mathieui committed
368
        **Default value:** ``true``
mathieui's avatar
mathieui committed
369

mathieui's avatar
mathieui committed
370
371
        Use this option to force the use of local bookmarks if needed.
        Anything but "false" will be counted as true.
mathieui's avatar
mathieui committed
372

mathieui's avatar
mathieui committed
373
    display_gaming_notifications
mathieui's avatar
mathieui committed
374

mathieui's avatar
mathieui committed
375
        **Default value:** ``false``
mathieui's avatar
mathieui committed
376

mathieui's avatar
mathieui committed
377
378
        If set to true, notifications about the games your are playing
        will be displayed in the info buffer as 'Gaming' messages.
mathieui's avatar
mathieui committed
379

mathieui's avatar
mathieui committed
380
    display_tune_notifications
mathieui's avatar
mathieui committed
381

mathieui's avatar
mathieui committed
382
        **Default value:** ``false``
mathieui's avatar
mathieui committed
383

mathieui's avatar
mathieui committed
384
385
        If set to true, notifications about the music your contacts listen to
        will be displayed in the info buffer as 'Tune' messages.
mathieui's avatar
mathieui committed
386

mathieui's avatar
mathieui committed
387
    display_mood_notifications
mathieui's avatar
mathieui committed
388

mathieui's avatar
mathieui committed
389
        **Default value:** ``false``
mathieui's avatar
mathieui committed
390

mathieui's avatar
mathieui committed
391
392
        If set to true, notifications about the mood of your contacts
        will be displayed in the info buffer as 'Mood' messages.
mathieui's avatar
mathieui committed
393

mathieui's avatar
mathieui committed
394
    display_activity_notifications
mathieui's avatar
mathieui committed
395

mathieui's avatar
mathieui committed
396
        **Default value:** ``false``
mathieui's avatar
mathieui committed
397

mathieui's avatar
mathieui committed
398
399
        If set to true, notifications about the current activity of your contacts
        will be displayed in the info buffer as 'Activity' messages.
mathieui's avatar
mathieui committed
400

mathieui's avatar
mathieui committed
401
    enable_xhtml_im
mathieui's avatar
mathieui committed
402

mathieui's avatar
mathieui committed
403
        **Default value:** ``true``
mathieui's avatar
mathieui committed
404

mathieui's avatar
mathieui committed
405
406
407
        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.
        Set to ``true`` if you want to see colored (and otherwise formatted) messages.
mathieui's avatar
mathieui committed
408

409
410
411
412
413
414
415
416
417
418
419
420
421
    request_message_receipts

        **Default value:** ``true``

        Request message receipts when sending messages (except in groupchats).

    ack_message_receipts

        **Default value:** ``true``

        Acknowledge message receipts requested by the other party.


mathieui's avatar
mathieui committed
422
    send_chat_states
mathieui's avatar
mathieui committed
423

mathieui's avatar
mathieui committed
424
        **Default value:** ``true``
mathieui's avatar
mathieui committed
425

mathieui's avatar
mathieui committed
426
427
428
        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.
mathieui's avatar
mathieui committed
429

mathieui's avatar
mathieui committed
430
431
432
        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.
mathieui's avatar
mathieui committed
433
434


mathieui's avatar
mathieui committed
435
    send_os_info
mathieui's avatar
mathieui committed
436

mathieui's avatar
mathieui committed
437
        **Default value:** ``true``
mathieui's avatar
mathieui committed
438

mathieui's avatar
mathieui committed
439
440
441
        If ``true``, information about the Operation System you're using
        will be sent when requested by anyone
        Set to ``false`` if you don't want people to know these informations.
mathieui's avatar
mathieui committed
442

mathieui's avatar
mathieui committed
443
        Note that this information will not be sent if :term:`send_poezio_info` is False
mathieui's avatar
mathieui committed
444

mathieui's avatar
mathieui committed
445
    send_poezio_info
mathieui's avatar
mathieui committed
446

mathieui's avatar
mathieui committed
447
        **Default value:** ``true``
mathieui's avatar
mathieui committed
448

mathieui's avatar
mathieui committed
449
450
451
        if true, information about the software (name and version)
        will be sent if requested by anyone
        Set to false if you don't want people to know these information
mathieui's avatar
mathieui committed
452

mathieui's avatar
mathieui committed
453
    send_time
mathieui's avatar
mathieui committed
454

mathieui's avatar
mathieui committed
455
        **Default value:** ``true``
mathieui's avatar
mathieui committed
456

mathieui's avatar
mathieui committed
457
458
        If ``true``, your current time will be sent if asked
        Set to ``false`` if you don't want people to know that information
mathieui's avatar
mathieui committed
459

mathieui's avatar
mathieui committed
460
461
Visual interface
~~~~~~~~~~~~~~~~
mathieui's avatar
mathieui committed
462

mathieui's avatar
mathieui committed
463
464
465
All these options will change how poezio looks, either by removing
parts of the interface, adding them, changing the ordering of stuff,
or the way messages are displayed.
mathieui's avatar
mathieui committed
466
467


mathieui's avatar
mathieui committed
468
469
.. glossary::
    :sorted:
mathieui's avatar
mathieui committed
470

mathieui's avatar
mathieui committed
471
    use_tab_nicks
mathieui's avatar
mathieui committed
472
473
474

        **Default value:** ``true``

mathieui's avatar
mathieui committed
475
476
477
        The tabs have a name, and a nick, which is, for a contact, its name in the
        roster, or for a private conversation, the nickname in the MUC. Set this to
        ``true`` if you want to have them shown instead of the jid of the contact.
mathieui's avatar
mathieui committed
478

mathieui's avatar
mathieui committed
479
    theme
mathieui's avatar
mathieui committed
480

mathieui's avatar
mathieui committed
481
        **Default value:** ``[empty]``
mathieui's avatar
mathieui committed
482

mathieui's avatar
mathieui committed
483
484
        The name of the theme file (without the .py extension) that will be used.
        The file should be located in the :term:`themes_dir` directory.
mathieui's avatar
mathieui committed
485

mathieui's avatar
mathieui committed
486
487
488
489
        If the file is not found (or no filename is specified) the default
        theme will be used instead

    themes_dir
mathieui's avatar
mathieui committed
490
491
492

        **Default value:** ``[empty]``

mathieui's avatar
mathieui committed
493
494
495
        If :term:`themes_dir` is not set, themes will searched for in
        ``$XDG_DATA_HOME/poezio/themes``, i.e. in ``~/.local/share/poezio/themes/``.
        So you should specify the directory you want to use instead.
mathieui's avatar
mathieui committed
496

mathieui's avatar
mathieui committed
497
        This directory will be created at startup if it doesn't exist
498

499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
    show_composing_tabs

        **Default value:** ``direct``

        Highlight tabs where the last activity was a "composing" chat state,
        which means the contact is currently typing.

        Possible values are:

        - ``direct``: highlight only in one-to-one chats (equiv. of private & conversation)
        - ``private``: highlight only in private chats inside chatrooms
        - ``conversation``: highlight only in chats with contacts or direct JIDs
        - ``muc``: highlight only in chatrooms
        - ``true``: highlight all possible tabs (equiv. of muc & private & conversation)
        - ``false`` or any other value: don’t highlight anything

mathieui's avatar
mathieui committed
515
    user_list_sort
516

mathieui's avatar
mathieui committed
517
        **Default value:** ``desc``
518

mathieui's avatar
mathieui committed
519
520
        If set to ``desc``, the MUC users will be displayed from top to bottom in the list,
        if set to ``asc``, they will be displayed from bottom to top.
mathieui's avatar
mathieui committed
521

522
523
524
525
526
527
528
529
530
    deterministic_nick_colors

        **Default value:** ``true``

        Use a deterministic algorithm to choose the user colors in chatrooms if
        set to ``true``. Otherwise the colors will be picked randomly.

        The value of this option affects the behavior of :term:`/recolor`.

mathieui's avatar
mathieui committed
531
    vertical_tab_list_size
mathieui's avatar
mathieui committed
532

mathieui's avatar
mathieui committed
533
        **Default value:** ``20``
mathieui's avatar
mathieui committed
534

mathieui's avatar
mathieui committed
535
        Size of the vertical tab list.
mathieui's avatar
mathieui committed
536

mathieui's avatar
mathieui committed
537
    vertical_tab_list_sort
mathieui's avatar
mathieui committed
538

mathieui's avatar
mathieui committed
539
        **Default value:** ``desc``
mathieui's avatar
mathieui committed
540

mathieui's avatar
mathieui committed
541
542
        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.
mathieui's avatar
mathieui committed
543

mathieui's avatar
mathieui committed
544
    filter_info_messages
mathieui's avatar
mathieui committed
545

mathieui's avatar
mathieui committed
546
        **Default value:** ``[empty]``
mathieui's avatar
mathieui committed
547

mathieui's avatar
mathieui committed
548
549
550
        A list of words or sentences separated by colons (":"). All the
        informational mesages (described above) containing at least one of those
        values will not be shown.
mathieui's avatar
mathieui committed
551

mathieui's avatar
mathieui committed
552
    hide_exit_join
mathieui's avatar
mathieui committed
553

mathieui's avatar
mathieui committed
554
        **Default value:** ``-1``
mathieui's avatar
mathieui committed
555

mathieui's avatar
mathieui committed
556
557
        Exact same thing than :term:`hide_status_change`, except that it concerns
        the quit message, and that it will be hidden only if the value is ``0``.
mathieui's avatar
mathieui committed
558

mathieui's avatar
mathieui committed
559
560
        Default setting means:
        - all quit and join notices will be displayed
mathieui's avatar
mathieui committed
561

mathieui's avatar
mathieui committed
562
    hide_status_change
mathieui's avatar
mathieui committed
563

mathieui's avatar
mathieui committed
564
        **Default value:** ``120``
mathieui's avatar
mathieui committed
565

mathieui's avatar
mathieui committed
566
567
568
        Set a number for this setting.
        The join AND status-change notices will be
        displayed according to this number.
mathieui's avatar
mathieui committed
569

mathieui's avatar
mathieui committed
570
        ``-1``: the notices will ALWAYS be displayed
mathieui's avatar
mathieui committed
571

mathieui's avatar
mathieui committed
572
        ``0``: the notices will NEVER be displayed
mathieui's avatar
mathieui committed
573

mathieui's avatar
mathieui committed
574
575
        ``n``: On any other number, the notices will only be displayed
        if the user involved has talked since the last n seconds
mathieui's avatar
mathieui committed
576

mathieui's avatar
mathieui committed
577
        if the value is incorrect, ``-1`` is assumed
mathieui's avatar
mathieui committed
578

mathieui's avatar
mathieui committed
579
580
        Default setting means that status changes won't be displayed
        unless the user talked in the last 2 minutes
mathieui's avatar
mathieui committed
581

mathieui's avatar
mathieui committed
582
    hide_user_list
mathieui's avatar
mathieui committed
583

mathieui's avatar
mathieui committed
584
        **Default value:** ``false``
mathieui's avatar
mathieui committed
585

mathieui's avatar
mathieui committed
586
587
588
        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
mathieui's avatar
mathieui committed
589

mathieui's avatar
mathieui committed
590
    highlight_on
mathieui's avatar
mathieui committed
591
592
593

        **Default value:** ``[empty]``

mathieui's avatar
mathieui committed
594
595
        a list of words (separated by a colon (:)) that will be
        highlighted if said by someone on a room
mathieui's avatar
mathieui committed
596

mathieui's avatar
mathieui committed
597
    information_buffer_popup_on
mathieui's avatar
mathieui committed
598

mathieui's avatar
mathieui committed
599
        **Default value:** ``error roster warning help info``
mathieui's avatar
mathieui committed
600

mathieui's avatar
mathieui committed
601
602
603
604
        Some informational messages (error, a contact getting connected, etc)
        are sometimes added to the information buffer. These settings can make
        that buffer grow temporarly so you can read these information when they
        appear.
mathieui's avatar
mathieui committed
605

mathieui's avatar
mathieui committed
606
607
        A list of message types that should make the information buffer grow
        Possible values: ``error``, ``roster``, ``warning``, ``info``, ``help``
mathieui's avatar
mathieui committed
608

mathieui's avatar
mathieui committed
609
    display_user_color_in_join_part
mathieui's avatar
mathieui committed
610

611
        **Default value:** ``true``
mathieui's avatar
mathieui committed
612

mathieui's avatar
mathieui committed
613
614
        If set to true, the color of the nick will be used in MUCs information
        messages, instead of the default color from the theme.
mathieui's avatar
mathieui committed
615

mathieui's avatar
mathieui committed
616
    enable_vertical_tab_list
mathieui's avatar
mathieui committed
617

mathieui's avatar
mathieui committed
618
        **Default value:** ``false``
mathieui's avatar
mathieui committed
619

mathieui's avatar
mathieui committed
620
621
        If ``true``, a vertical list of tabs, with their name, is displayed on the left of
        the screen.
mathieui's avatar
mathieui committed
622

mathieui's avatar
mathieui committed
623
    max_nick_length
mathieui's avatar
mathieui committed
624

mathieui's avatar
mathieui committed
625
        **Default value:** ``25``
mathieui's avatar
mathieui committed
626

mathieui's avatar
mathieui committed
627
628
629
        The maximum length of the nickname that will be displayed in the
        conversation window. Nicks that are too long will be truncated and have
        a ``…`` appened to them.
mathieui's avatar
mathieui committed
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

    roster_group_sort

        **Default value:** ``name``

        How to sort the roster groups. The principles are the same as :term:`roster_sort`
        (see below).

        Available methods are:
          * ``reverse``: reverse the current sorting
          * ``name``: sort by group name (alphabetical order)
          * ``fold``: sort by 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

    roster_show_offline

        **Default value:** ``false``

        Set this to true if you want to display the offline contacts too.

    roster_sort

        **Default value:** ``jid:show``

        How you want the contacts to be sorted inside the roster groups. The given
        methods are used sequentially (from left to right), so the last one is the
        one on the far right.

        Available methods are :

        * ``reverse``: reverse the current sorting
        * ``jid``: sort by JID (alphabetical order)
        * ``show``: sort by show (available/away/xa/…)
        * ``name``: sort by roster name (if no name, then the bare jid is used)
        * ``resource``: sort by resource number
        * ``online``: sort by online presence (online or not)

        Those methods can be arranged however you like, and they have to be
        separated by colons (":"). If there are more than 3 or 4 chained
        sorting methods, your sorting is most likely inefficient.

mathieui's avatar
mathieui committed
673
    show_inactive_tabs
mathieui's avatar
mathieui committed
674
675
676

        **Default value:** ``true``

mathieui's avatar
mathieui committed
677
678
        If you want to show all the tabs in the Tab bar, even those
        with no activity, set to ``true``. Else, set to ``false``.
mathieui's avatar
mathieui committed
679

mathieui's avatar
mathieui committed
680
    show_muc_jid
mathieui's avatar
mathieui committed
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701

        **Default value:** ``true``

        Set this to ``false`` if you want to display only the “user” part of the MUC
        jid. E.g. if you have **poezio@muc.poezio.eu**, it will be displayed as
        **poezio**. This will be used only if :term:`use_tab_nicks` is set to ``true``.

    show_roster_jids

        **Default value:** ``true``

        Set this to ``false`` if you want to hide the JIDs in the roster (and keep only
        the contact names). If there is no contact name, the JID will still be
        displayed.

    show_s2s_errors

        **Default value:** ``true``

        Show s2s errors in the roster or not.

702
703
704
705
706
707
708
709
710
711
712
    show_roster_subscriptions

        **Defalt value:** ``[empty]``

        Select the level of display of subscriptions with a char the roster

        - ``all`` to display all subscriptions
        - ``incomplete`` to display *from*, *to* and *none*
        - one of ``from``, ``to``, ``none`` and ``both`` to display only that one
        - no value or any other value to disable it

mathieui's avatar
mathieui committed
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
    show_tab_names

        **Default value:** ``false``

        If you want to show the tab name in the bottom Tab bar, set this to ``true``.

    show_tab_numbers

        **Default value:** ``true``

        If you want to disable the numbers in the bottom Tab bar, set this to ``false``.
        Note that if both :term:`show_tab_names` and :term:`show_tab_numbers` are set to ``false``, the
        numbers will still be displayed.

    show_timestamps

        **Default value:** ``true``

        Whether or not to display a timestamp before each message.

mathieui's avatar
mathieui committed
733
734
735
736
737
738
739
740
    create_gaps

        **Default:** ``false``

        Create gaps when moving a tab or closing it. Enabling this option
        will help you keep the tabs at the same place during the execution of
        poezio. (gaps are not created when the closed tab is the last one)

mathieui's avatar
mathieui committed
741
    popup_time
mathieui's avatar
mathieui committed
742

mathieui's avatar
mathieui committed
743
        **Default value:** ``4``
mathieui's avatar
mathieui committed
744

mathieui's avatar
mathieui committed
745
746
747
748
        The time the message will be visible in the information buffer when it
        pops up.
        If the message takes more than one line, the popup will stay visible
        two more second per additional lines.
mathieui's avatar
mathieui committed
749

750
751
752
753
754
755
756
757
758
    muc_colors (section)

        **Default:** ``[empty]``

        Fix a color for a nick. Whenever such a nick appears in a MUC, it will
	be displayed in that color. This color won't be changed by the recolor
	command.


mathieui's avatar
mathieui committed
759
760
User Interaction
~~~~~~~~~~~~~~~~
mathieui's avatar
mathieui committed
761

mathieui's avatar
mathieui committed
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
Options that change the behavior of poezio in a non-visual manner.

.. glossary::
    :sorted:

    add_space_after_completion

        **Default value:** ``true``

        Whether or not to add a space after a completion in the middle of the
        input (not at the start of it)

    after_completion

        **Default value:** ``,``

        What will be put after the name, when using autocompletion at the
        beginning of the input. A space will always be added after that


    beep_on

        **Default value:** ``highlight private``

        The terminal can beep on various event. Put the event you want in a list
        (separated by spaces).

        The events can be
        - ``highlight`` (when you are highlighted in a MUC)
        - ``private`` (when a new private message is received, from your contacts or someone from a MUC)
        - ``message`` (any message from a MUC)

    separate_history

        **Default value:** ``false``

        If true, the history of inputs of the same nature won’t be shared
        between tabs (as in weechat).

    words
mathieui's avatar
mathieui committed
802
803
804

        **Default value:** ``[empty]``

mathieui's avatar
mathieui committed
805
806
807
808
        Personal dictionary of the words you use often, that you want to complete
        through recent words completion. They must be separated bu a colon (:). That
        completion will work in chatrooms, private conversations, and direct
        conversations.
mathieui's avatar
mathieui committed
809

mathieui's avatar
mathieui committed
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
Logging
~~~~~~~

Options related to logging.

.. glossary::
    :sorted:

    load_log

        **Default value:** ``10``

        The number of line to preload in a chat buffer when it opens. The lines are
        loaded from the log files.
        ``0`` or a negative value here disable that option.

    log_dir
mathieui's avatar
mathieui committed
827
828
829

        **Default value:** ``[empty]``

mathieui's avatar
mathieui committed
830
831
832
833
834
835
836
837
        If :term:`log_dir` is not set, logs will be saved in ``$XDG_DATA_HOME/poezio/logs``,
        i.e. in ``~/.local/share/poezio/logs/``. So, you should specify the directory
        you want to use instead. This directory will be created if it doesn't exist.

    log_errors

        **Default value:** ``true``

838
        Logs all the tracebacks and erors of poezio/slixmpp in
mathieui's avatar
mathieui committed
839
        :term:`log_dir`/errors.log by default. ``false`` disables this option.
mathieui's avatar
mathieui committed
840
841
842
843
844
845
846
847

    use_log

        **Default value:** ``true``

        Set to ``false`` if you don’t want to save logs of all the messages
        in files.

mathieui's avatar
mathieui committed
848
849
Plugins
~~~~~~~
mathieui's avatar
mathieui committed
850

mathieui's avatar
mathieui committed
851
852
This sections references the configuration of the plugin system; for
more details, go to the :ref:`dedicated page<plugins-doc>`.
mathieui's avatar
mathieui committed
853

mathieui's avatar
mathieui committed
854
855
.. glossary::
    :sorted:
mathieui's avatar
mathieui committed
856

mathieui's avatar
mathieui committed
857
    plugins_autoload
mathieui's avatar
mathieui committed
858

mathieui's avatar
mathieui committed
859
        **Default value:** ``[empty]``
mathieui's avatar
mathieui committed
860

mathieui's avatar
mathieui committed
861
        Colon-separated list of plugins to load on startup.
mathieui's avatar
mathieui committed
862

mathieui's avatar
mathieui committed
863
    plugins_conf_dir
mathieui's avatar
mathieui committed
864

mathieui's avatar
mathieui committed
865
        **Default value:** ``[empty]``
mathieui's avatar
mathieui committed
866

mathieui's avatar
mathieui committed
867
868
869
870
        If plugins_conf_dir is not set, plugin configs will be loaded from
        :file:`$XDG_CONFIG_HOME/poezio/plugins`.
        You can specify another directory to use, it will be created if it
        does not exist.
mathieui's avatar
mathieui committed
871

mathieui's avatar
mathieui committed
872
    plugins_dir
mathieui's avatar
mathieui committed
873
874
875

        **Default value:** ``[empty]``

mathieui's avatar
mathieui committed
876
877
878
879
        If plugins_dir is not set, plugins will be loaded from
        ``$XDG_DATA_HOME/poezio/plugins``.
        You can specify another directory to use. It will be created if it
        does not exist.
mathieui's avatar
mathieui committed
880
881
882



mathieui's avatar
mathieui committed
883
884
Other
~~~~~
mathieui's avatar
mathieui committed
885

mathieui's avatar
mathieui committed
886
887
.. glossary::
    :sorted:
mathieui's avatar
mathieui committed
888

mathieui's avatar
mathieui committed
889
    exec_remote
mathieui's avatar
mathieui committed
890

mathieui's avatar
mathieui committed
891
        **Default value:** ``false``
mathieui's avatar
mathieui committed
892

mathieui's avatar
mathieui committed
893
894
895
        If this is set to ``true``, poezio will try to send the commands to a FIFO
        instead of executing them locally. This is to be used in conjunction with
        ssh and the daemon.py file. See the :term:`/link` documentation for details.
mathieui's avatar
mathieui committed
896
897


mathieui's avatar
mathieui committed
898
    lang
mathieui's avatar
mathieui committed
899

mathieui's avatar
mathieui committed
900
        **Default value:** ``en``
mathieui's avatar
mathieui committed
901

mathieui's avatar
mathieui committed
902
        The lang some automated entities will use when replying to you.
mathieui's avatar
mathieui committed
903

904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
    extract_inline_images

        **Default value:** ``true``

        Some clients send inline images in base64 inside some messages, which results in
        an useless wall of text. If this option is ``true``, then that base64 text will
        be replaced with a :file:`file://` link to the image file extracted in
        :term:`tmp_image_dir` or :file:`$XDG_CACHE_HOME/poezio/images` by default, which
        is usually :file:`~/.cache/poezio/images`

    tmp_image_dir

        **Default value:** ``[empty]``

        The directory where poezio will save the images received, if
        :term:`extract_inline_images` is set to true. If unset, poezio
        will default to :file:`$XDG_CACHE_HOME/poezio/images` which is
        usually :file:`~/.cache/poezio/images`.

mathieui's avatar
mathieui committed
923
    muc_history_length
mathieui's avatar
mathieui committed
924

mathieui's avatar
mathieui committed
925
        **Default value:** ``50``
mathieui's avatar
mathieui committed
926

mathieui's avatar
mathieui committed
927
928
        Limit the number of messages you want to receive when the
        multiuserchat rooms send you recent history
mathieui's avatar
mathieui committed
929

mathieui's avatar
mathieui committed
930
        ``0``: You won't receive any
mathieui's avatar
mathieui committed
931

mathieui's avatar
mathieui committed
932
        ``-1``: You will receive the maximum
mathieui's avatar
mathieui committed
933

mathieui's avatar
mathieui committed
934
935
936
937
938
939
940
941
        ``n``: You will receive at most n messages

        Note that if you set a huge number (like the default value), you
        may not receive that much messages. The server has its own
        maximum too.

    remote_fifo_path

942
        **Default value:** ``./``
mathieui's avatar
mathieui committed
943
944

        The path of the FIFO used to send the commands (see the :term:`exec_remote` option).
945
946
        Poezio will try to create a :file:`poezio.fifo` file in this directory.

mathieui's avatar
mathieui committed
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

    save_status

        **Default value:** ``true``

        Save the status automatically in the :term:`status` and :term:`status_message` options.

    send_initial_presence

        **Default value:** ``true``

        Send initial presence (normal behaviour). If ``false``, you will not send nor
        receive any presence that is not directed (through :term:`/presence`) or sent by a
        MUC.

    lazy_resize

        **Default value:** ``true``

        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

    max_lines_in_memory

        **Default value:** ``2048``

        Configure the number of maximum lines (for each tab) that
        can be kept in memory. If poezio consumes too much memory, lower these
        values

    max_messages_in_memory

        **Default value:** ``2048``

        Configure the number of maximum messages (for each tab) that
        can be kept in memory. If poezio consumes too much memory, lower these
        values
mathieui's avatar
mathieui committed
985
986
987
988
989
990





Optional section options
mathieui's avatar
mathieui committed
991
992
------------------------

mathieui's avatar
mathieui committed
993
994
995
996
997
998
999
1000
These option can appear in optional sections. These section are named
after a JID. These option will apply only for the given JID. For example
if an option appears in a section named [user@example.com], it will
apply only for the conversations with user@example.com.

If an option appears in a section named [@example.com], it will apply
for all the conversations with people @example.com, except when the option
is already defined in a [user@example.com] section.
For faster browsing, not all history is shown. View entire blame