summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormathieui <mathieui@mathieui.net>2014-09-26 13:54:50 +0200
committermathieui <mathieui@mathieui.net>2014-09-26 13:55:26 +0200
commit41a89dc2acb98a2aa50d6fd9ab37a2be65f5cfa0 (patch)
tree439abc3a250b06945cbad762de0f1a25a05f1984
parentbec71fe38d76524cdf04866180f5e3eec4f13701 (diff)
downloadpoezio-41a89dc2acb98a2aa50d6fd9ab37a2be65f5cfa0.tar.gz
poezio-41a89dc2acb98a2aa50d6fd9ab37a2be65f5cfa0.tar.bz2
poezio-41a89dc2acb98a2aa50d6fd9ab37a2be65f5cfa0.tar.xz
poezio-41a89dc2acb98a2aa50d6fd9ab37a2be65f5cfa0.zip
Update OTR documentation
-rw-r--r--plugins/otr.py16
1 files changed, 9 insertions, 7 deletions
diff --git a/plugins/otr.py b/plugins/otr.py
index 74b06cf1..47f1fc11 100644
--- a/plugins/otr.py
+++ b/plugins/otr.py
@@ -41,8 +41,8 @@ Install the python module:
cd pure-python-otr
python3 setup.py install --user
-You can also use pip with the requirements.txt at the root of
-the poezio directory.
+You can also use pip in a virtualenv (built-in as pyvenv_ with python since 3.3)
+with the requirements.txt at the root of the poezio directory.
Usage
@@ -148,20 +148,22 @@ Configuration
Log conversations (OTR start/end marker, and messages).
-The :term:`allow_v1`, :term:`allow_v2`, :term:`decode_html`
+The :term:`allow_v1`, :term:`allow_v2`, :term:`decode_xhtml`
and :term:`log` configuration parameters are tab-specific.
Important details
-----------------
-The OTR session is considered for a full jid, but the trust is considered
-with a bare JID. This is important to know in the case of Private Chats, since
-you cannot always get the real the JID of your contact (or check if the same
-nick is used by different people).
+The OTR session is considered for a full JID (e.g. toto@example/**client1**),
+but the trust is set with a bare JID (e.g. toto@example). This is important
+in the case of Private Chats (in a chatroom), since you cannot always get the
+real JID of your contact (or check if the same nick is used by different people).
.. _Off The Record messaging: http://wiki.xmpp.org/web/OTR
+.. _pyvenv: https://docs.python.org/3/using/scripts.html#pyvenv-creating-virtual-environments
"""
+
from gettext import gettext as _
import potr
import logging