summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/configuration.rst27
-rw-r--r--doc/source/install.rst5
-rw-r--r--doc/source/misc/correct.rst2
3 files changed, 33 insertions, 1 deletions
diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst
index 32d82f7a..d0ff5bbe 100644
--- a/doc/source/configuration.rst
+++ b/doc/source/configuration.rst
@@ -316,6 +316,14 @@ to understand what is :ref:`carbons <carbons-details>` or
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.
+ 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.
+
use_bookmark_method
**Default value:** ``[empty]``
@@ -851,6 +859,25 @@ Other
The lang some automated entities will use when replying to you.
+ 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`.
+
muc_history_length
**Default value:** ``50``
diff --git a/doc/source/install.rst b/doc/source/install.rst
index b655894b..dbe5ddfa 100644
--- a/doc/source/install.rst
+++ b/doc/source/install.rst
@@ -80,6 +80,8 @@ Poezio depends on two libraries:
- DNSPython_ (the python3 version, often called dnspython3)
- SleekXMPP_
+Additionally, it needs *python3-setuptools* to install an executable file.
+
If you do not want to install those libraries, you can skip directly to
the :ref:`installation part <poezio-install-label>`
@@ -139,7 +141,8 @@ If you have git installed, it will download and update locally the
libraries for you. (and if you don’t have git installed, install it)
-If you really want to install it, run as root (or sudo in ubuntu or whatever):
+If you really want to install it, first install the *python3-setuptools* package
+in your distribution, then run as root (or sudo in ubuntu or whatever):
.. code-block:: bash
diff --git a/doc/source/misc/correct.rst b/doc/source/misc/correct.rst
index 61100634..fda4abcb 100644
--- a/doc/source/misc/correct.rst
+++ b/doc/source/misc/correct.rst
@@ -1,3 +1,5 @@
+.. _correct-feature:
+
Message Correction
==================