summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorEmmanuel Gil Peyrot <linkmauve@linkmauve.fr>2020-05-24 16:21:14 +0200
committerEmmanuel Gil Peyrot <linkmauve@linkmauve.fr>2020-05-24 16:21:14 +0200
commit3d912230664e7179b0f6dc58b8b454118cca033e (patch)
treea72e165324d7e050bd0115835c84c4b592f9e70c /doc
parentcfa75f8877963cfee9c22565dad60ddf7dee3c95 (diff)
downloadpoezio-3d912230664e7179b0f6dc58b8b454118cca033e.tar.gz
poezio-3d912230664e7179b0f6dc58b8b454118cca033e.tar.bz2
poezio-3d912230664e7179b0f6dc58b8b454118cca033e.tar.xz
poezio-3d912230664e7179b0f6dc58b8b454118cca033e.zip
Rename bookmark_on_join to synchronise_open_rooms
Also add some more documentation about it.
Diffstat (limited to 'doc')
-rw-r--r--doc/source/configuration.rst14
1 files changed, 10 insertions, 4 deletions
diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst
index aceb6fb4..6af57ce7 100644
--- a/doc/source/configuration.rst
+++ b/doc/source/configuration.rst
@@ -371,12 +371,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 ``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.
+
+ If ``true``, ``/join`` will create a bookmark with ``autojoin=true``,
+ and ``/leave`` will remove said bookmark.
- If ``true``, poezio will bookmark automatically every room that is joined with
- a manual ``/join`` command.
+ This was previously named ``bookmark_on_join``.
force_remote_bookmarks