summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/commands.rst7
-rw-r--r--doc/source/configuration.rst2
-rw-r--r--doc/source/dev/xep.rst37
-rw-r--r--doc/source/images/correct.pngbin632 -> 313 bytes
-rw-r--r--doc/source/images/muc.pngbin17818 -> 15709 bytes
-rw-r--r--doc/source/images/pep.pngbin1276 -> 1113 bytes
-rw-r--r--doc/source/images/pep_infos.pngbin4363 -> 3714 bytes
-rw-r--r--doc/source/images/roster.pngbin11280 -> 10142 bytes
-rw-r--r--doc/source/images/theme_256_colors.pngbin37316 -> 37242 bytes
-rw-r--r--doc/source/images/vert_tabs.pngbin2890 -> 1901 bytes
-rw-r--r--doc/source/install.rst26
-rw-r--r--doc/source/keys.rst2
-rw-r--r--doc/source/theme/static/poezio.pngbin4820 -> 4431 bytes
13 files changed, 67 insertions, 7 deletions
diff --git a/doc/source/commands.rst b/doc/source/commands.rst
index 64a2f033..83884a6a 100644
--- a/doc/source/commands.rst
+++ b/doc/source/commands.rst
@@ -88,9 +88,10 @@ These commands work in *any* tab.
/win
/w
- **Usage:** ``/win <number>``
+ **Usage:** ``/win <number or string>``
- Go to the specified room.
+ Go to the matching tab. If the argument is a number, it goes to the tab with that number.
+ Otherwise, it goes to the next tab whose name contains the given string.
/status
**Usage:** ``/status <availability> [status message]``
@@ -624,7 +625,7 @@ XML tab commands
Write the content of the XML buffer into a file.
- /reset
+ /filter_reset
Reset the stanza filters.
/filter_id
diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst
index 3f9cd094..8d88a071 100644
--- a/doc/source/configuration.rst
+++ b/doc/source/configuration.rst
@@ -133,7 +133,7 @@ Options related to account configuration, nickname…
**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
+ If this is empty, the $USER environment variable will be used
server
diff --git a/doc/source/dev/xep.rst b/doc/source/dev/xep.rst
index cb06d2c8..4f9ab31d 100644
--- a/doc/source/dev/xep.rst
+++ b/doc/source/dev/xep.rst
@@ -19,12 +19,20 @@ Table of all XEPs implemented in poezio.
+----------+-------------------------+---------------------+
|0048 |Bookmarks |90% |
+----------+-------------------------+---------------------+
+|0049 |Private XML Storage |100% |
++----------+-------------------------+---------------------+
+|0050 |Ad-Hoc Commands |70% |
++----------+-------------------------+---------------------+
|0054 |vcard-temp |30% |
+----------+-------------------------+---------------------+
+|0060 |Publish-Subscribe |10% |
++----------+-------------------------+---------------------+
|0070 |HTTP Request Verification|~100% |
+----------+-------------------------+---------------------+
|0071 |XHTML-IM |~70% |
+----------+-------------------------+---------------------+
+|0077 |In-Band Registration |50% |
++----------+-------------------------+---------------------+
|0085 |Chat State Notifications |100% |
+----------+-------------------------+---------------------+
|0092 |Software Version |100% |
@@ -37,12 +45,21 @@ Table of all XEPs implemented in poezio.
+----------+-------------------------+---------------------+
|0118 |User Tune |90% |
+----------+-------------------------+---------------------+
+|0163 |Personal Eventing |100% |
+| |Protocol | |
++----------+-------------------------+---------------------+
|0172 |User Nickname |100% |
+----------+-------------------------+---------------------+
+|0175 |Best Practices for Use of|100% |
+| |SASL ANONYMOUS | |
++----------+-------------------------+---------------------+
+|0178 |Best Practices for Use of|100% |
+| |SASL EXTERNAL with | |
+| |Certificates | |
++----------+-------------------------+---------------------+
|0184 |Message Delivery Receipts|100% |
+----------+-------------------------+---------------------+
-|0191 |Simple Communication |95% |
-| |Blocking | |
+|0191 |Blocking Command |95% |
+----------+-------------------------+---------------------+
|0196 |User Gaming |70% |
+----------+-------------------------+---------------------+
@@ -52,6 +69,8 @@ Table of all XEPs implemented in poezio.
+----------+-------------------------+---------------------+
|0202 |Entity time |100% |
+----------+-------------------------+---------------------+
+|0203 |Delayed Delivery |100% |
++----------+-------------------------+---------------------+
|0224 |Attention |100% |
+----------+-------------------------+---------------------+
|0231 |Bits of Binary |30% |
@@ -60,6 +79,10 @@ Table of all XEPs implemented in poezio.
+----------+-------------------------+---------------------+
|0249 |Direct MUC Invitations |90% |
+----------+-------------------------+---------------------+
+|0257 |Client Certificate |100% |
+| |Management for SASL | |
+| |EXTERNAL | |
++----------+-------------------------+---------------------+
|0270 |Compliance Suites 2010 |Advanced Client |
+----------+-------------------------+---------------------+
|0280 |Messsage Carbons |100% |
@@ -67,13 +90,23 @@ Table of all XEPs implemented in poezio.
|0296 |Best Practices for |100% |
| |Resource Locking | |
+----------+-------------------------+---------------------+
+|0297 |Stanza Forwarding |100% |
++----------+-------------------------+---------------------+
|0302 |Compliance Suites 2012 |Advanced Client |
+----------+-------------------------+---------------------+
|0308 |Last Message Correction |100% |
+----------+-------------------------+---------------------+
+|0319 |Last User Interaction In |100% |
+| |Presence | |
++----------+-------------------------+---------------------+
+|0334 |Message Processing Hints |100% |
++----------+-------------------------+---------------------+
|0352 |Client State Indication |100% |
+----------+-------------------------+---------------------+
|0364 |Current OTR Usage |100% |
+----------+-------------------------+---------------------+
+|0375 |Compliance Suites 2016 |Advanced Client + |
+| | |Core Mobile |
++----------+-------------------------+---------------------+
|0378 |OTR Discovery |100% |
+----------+-------------------------+---------------------+
diff --git a/doc/source/images/correct.png b/doc/source/images/correct.png
index ed2ad450..39d9ef87 100644
--- a/doc/source/images/correct.png
+++ b/doc/source/images/correct.png
Binary files differ
diff --git a/doc/source/images/muc.png b/doc/source/images/muc.png
index 8ddfff10..a79e4ac0 100644
--- a/doc/source/images/muc.png
+++ b/doc/source/images/muc.png
Binary files differ
diff --git a/doc/source/images/pep.png b/doc/source/images/pep.png
index 96f5118d..b6444911 100644
--- a/doc/source/images/pep.png
+++ b/doc/source/images/pep.png
Binary files differ
diff --git a/doc/source/images/pep_infos.png b/doc/source/images/pep_infos.png
index df7211d6..170ff910 100644
--- a/doc/source/images/pep_infos.png
+++ b/doc/source/images/pep_infos.png
Binary files differ
diff --git a/doc/source/images/roster.png b/doc/source/images/roster.png
index d1a8f9f4..e599c46d 100644
--- a/doc/source/images/roster.png
+++ b/doc/source/images/roster.png
Binary files differ
diff --git a/doc/source/images/theme_256_colors.png b/doc/source/images/theme_256_colors.png
index 395f3d39..16a4511c 100644
--- a/doc/source/images/theme_256_colors.png
+++ b/doc/source/images/theme_256_colors.png
Binary files differ
diff --git a/doc/source/images/vert_tabs.png b/doc/source/images/vert_tabs.png
index a48a8051..c3b3f06b 100644
--- a/doc/source/images/vert_tabs.png
+++ b/doc/source/images/vert_tabs.png
Binary files differ
diff --git a/doc/source/install.rst b/doc/source/install.rst
index 1f3836ab..cf74b08e 100644
--- a/doc/source/install.rst
+++ b/doc/source/install.rst
@@ -195,6 +195,31 @@ If you did, it should be in the ``$PATH`` as ``poezio``, so run:
poezio
+Docker images
+-------------
+
+poezio is available on the docker hub in the `poezio/poezio`_ repository
+in which ``poezio/poezio:latest`` is the latest built git version, and
+stable versions are tagged with their numbers. The image is based off
+alpine linux and we tried to keep the image size to a minimum (<100MiB).
+
+You can therefore just fetch the images with docker pull:
+
+.. code-block:: bash
+
+ docker pull poezio/poezio
+
+In order to run poezio with non-temporary config and logs, and to have
+the right colors, you have to share the ``TERM`` env var and some directories:
+
+.. code-block:: bash
+
+ docker run -it -e TERM -v ~/.config/poezio:/home/poezio-user/.config/poezio -v ~/.local/share/poezio:/home/poezio-user/.local/share/poezio poezio/poezio
+
+
+If you don’t trust images distributed on the docker hub, you can rebuild the
+image from the Dockerfile at the root of the git repository.
+
.. _stable sources: https://dev.louiz.org/project/poezio/download
.. _slixmpp: https://dev.louiz.org/projects/slixmpp
.. _aiodns: https://github.com/saghul/aiodns
@@ -206,3 +231,4 @@ If you did, it should be in the ``$PATH`` as ``poezio``, so run:
.. _cython: http://cython.org
.. _bgo-overlay: https://bgo.zugaina.org/
.. _port: http://ports.su/net/poezio
+.. _poezio/poezio: https://hub.docker.com/r/poezio/poezio/
diff --git a/doc/source/keys.rst b/doc/source/keys.rst
index 57b8c22e..ae641c26 100644
--- a/doc/source/keys.rst
+++ b/doc/source/keys.rst
@@ -69,7 +69,7 @@ and save it to the clipboard.
**Ctrl-y**: Insert the content of the clipboard at the cursor position.
-**Ctrl-Enter**: Insert a line break. Since the input is only one line,
+**Ctrl-Enter** or **Ctrl-j**: Insert a line break. Since the input is only one line,
the line break is represented by the character ``|`` in it but will be
sent as the real ``\n`` character.
diff --git a/doc/source/theme/static/poezio.png b/doc/source/theme/static/poezio.png
index 6ab506c1..02a7c5eb 100644
--- a/doc/source/theme/static/poezio.png
+++ b/doc/source/theme/static/poezio.png
Binary files differ