diff options
Diffstat (limited to 'doc/source/configuration.rst')
-rw-r--r-- | doc/source/configuration.rst | 166 |
1 files changed, 64 insertions, 102 deletions
diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst index 6baa6a27..c28f38fa 100644 --- a/doc/source/configuration.rst +++ b/doc/source/configuration.rst @@ -10,8 +10,8 @@ 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 in the :ref:`keys-page` documentation file. -That file is read at each startup and the configuration is saved when poezio -is closed. +The configuration is read at each startup or when the `/reload` command is +issued, and it is updated after every `/set` command. This configuration file **requires** all global options to be in a section named [Poezio]. Some other options can be in optional sections and will @@ -133,6 +133,15 @@ Options related to account configuration, nickname… This option can be combined with :term:`custom_host`. You should not need this in a "normal" use case. + default_muc_service + + **Default value:** ``[empty]`` + + If specified, will be used instead of the MUC service provided by + the user domain. + + .. versionadded:: 0.13 + default_nick **Default value:** ``[empty]`` @@ -145,7 +154,7 @@ Options related to account configuration, nickname… **Default value:** ``anon.jeproteste.info`` The server to use for anonymous authentication; - make sure it supports anonymous authentification. + make sure it supports anonymous authentication. Note that this option doesn’t do anything at all if you’re using your own JID. @@ -315,37 +324,12 @@ to understand what is :ref:`carbons <carbons-details>` or as mobile networks). It can however increase bandwidth usage. It also requires server support. - 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. - go_to_previous_tab_on_alt_number **Default value:** ``false`` @@ -362,19 +346,18 @@ to understand what is :ref:`carbons <carbons-details>` or sender intended it as such. See :ref:`Message Correction <correct-feature>` for more information. - bookmark_on_join + synchronise_open_rooms - **Default value:** ``false`` + **Default value:** ``true`` - If ``true``, poezio will bookmark automatically every room that is joined with - a manual ``/join`` command. + If ``false``, poezio will not store the state of currently open rooms, + so that if you leave a room and restart poezio (or start another + client) it will reopen it. - force_remote_bookmarks + If ``true``, ``/join`` will create a bookmark with ``autojoin=true``, + and ``/leave`` will remove said bookmark. - **Default value:** ``false`` - - Try to retrieve your remote bookmarks, even when your server doesn’t advertise - support. + This was previously named ``bookmark_on_join``. use_bookmark_method @@ -398,40 +381,12 @@ to understand what is :ref:`carbons <carbons-details>` or Use this option to force the use of local bookmarks if needed. Anything but "false" will be counted as true. - display_gaming_notifications - - **Default value:** ``false`` - - If set to true, notifications about the games your are playing - will be displayed in the info buffer as 'Gaming' messages. - - display_tune_notifications - - **Default value:** ``false`` - - If set to true, notifications about the music your contacts listen to - will be displayed in the info buffer as 'Tune' messages. - - display_mood_notifications - - **Default value:** ``false`` - - If set to true, notifications about the mood of your contacts - will be displayed in the info buffer as 'Mood' messages. - - display_activity_notifications - - **Default value:** ``false`` - - If set to true, notifications about the current activity of your contacts - will be displayed in the info buffer as 'Activity' messages. - enable_xhtml_im **Default value:** ``true`` 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. + XHTML and CSS formatting. We can use this to make colored text for example. Set to ``true`` if you want to see colored (and otherwise formatted) messages. enable_css_parsing @@ -557,23 +512,14 @@ or the way messages are displayed. bottom in the list, if set to ``asc``, they will be displayed from bottom to top. - 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`. - nick_color_aliases **Default value:** ``true`` - Automatically search for color of nick aliases. For example, if nick is - set to red, _nick, nick\_, _nick_, nick\__ etc. will have the same color. - Aliases colors are checked first, so that it is still possible to have - different colors for nick\_ and nick. + Automatically search for color of nick aliases. For example, if nick is + set to red, _nick, nick\_, _nick_, nick\__ etc. will have the same color. + Aliases colors are checked first, so that it is still possible to have + different colors for nick\_ and nick. vertical_tab_list_size @@ -593,7 +539,7 @@ or the way messages are displayed. **Default value:** ``[empty]`` A list of words or sentences separated by colons (":"). All the - informational mesages (described above) containing at least one of those + informational messages (described above) containing at least one of those values will not be shown. hide_exit_join @@ -647,7 +593,7 @@ or the way messages are displayed. 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 + that buffer grow temporarily so you can read these information when they appear. A list of message types that should make the information buffer grow @@ -671,6 +617,14 @@ or the way messages are displayed. If set to true, the color of the nick will be used in chatroom information messages, instead of the default color from the theme. + autocolor_tab_names + + **Default value:** ``false`` + + If ``true``, uses deterministic coloration for tab names or tab + numbers in the activity bar, using Consistent Color Generation + (XEP-0392). + enable_vertical_tab_list **Default value:** ``true`` @@ -769,7 +723,7 @@ or the way messages are displayed. show_roster_subscriptions - **Defalt value:** ``[empty]`` + **Default value:** ``[empty]`` Select the level of display of subscriptions with a char in the contact list. @@ -784,6 +738,17 @@ or the way messages are displayed. If you want to show the tab name in the bottom Tab bar, set this to ``true``. + unique_prefix_tab_names + + **Default value:** ``false`` + + If this and :term:`show_tab_names` is set to true, only the shortest + unique prefix of each tab name is shown instead of the full name. This + can declutter the interface in an instance with many tabs shown in the + interface, while not having to use numbers (which may change completely due to reordering). + + Takes precedence over `use_tab_nicks`. + show_tab_numbers **Default value:** ``true`` @@ -883,14 +848,6 @@ 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 **Default value:** ``[empty]`` @@ -903,7 +860,7 @@ Options related to logging. **Default value:** ``true`` - Logs all the tracebacks and erors of poezio/slixmpp in + Logs all the tracebacks and errors of poezio/slixmpp in :term:`log_dir`/errors.log by default. ``false`` disables this option. use_log @@ -912,6 +869,21 @@ Options related to logging. Set to ``false`` if you don’t want to write any message to the disk. + mam_sync + + **Default value:** ``true`` + + If ``true``, will try to fill local logs with missing MAM history + when opening a tab or joining a room. + + mam_sync_limit + + **Default value:** ``2000`` + + Maximum number of messages to fetch on a MAM sync. Will affect + performance when joining rooms with a huge backlog for the first time + or after a long period. + Plugins ~~~~~~~ @@ -1115,7 +1087,7 @@ found. display_user_color_in_join_part - **Default value:** ``false`` + **Default value:** ``true`` If set to ``true``, the color of the nick will be used in chatroom information messages, instead of the default color from the theme. @@ -1168,16 +1140,6 @@ found. Ignore private messages sent from this room. - 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. - - No value makes poezio fall back to the global value. - password **Default value:** ``[empty]`` |