summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authormathieui <mathieui@mathieui.net>2014-10-14 15:51:30 +0200
committermathieui <mathieui@mathieui.net>2014-10-14 15:51:30 +0200
commit545ad1bd71e87a482b357f5b49a0898be73478d8 (patch)
treee513febd81f0c3d338b047f0672e5353e92534d4 /doc/source
parent37fe4be7ec35278f23c9f5c07607c3a14e6b6753 (diff)
parent088c6c6a0b46309d17c4b0ba5939a2dd200c7002 (diff)
downloadpoezio-545ad1bd71e87a482b357f5b49a0898be73478d8.tar.gz
poezio-545ad1bd71e87a482b357f5b49a0898be73478d8.tar.bz2
poezio-545ad1bd71e87a482b357f5b49a0898be73478d8.tar.xz
poezio-545ad1bd71e87a482b357f5b49a0898be73478d8.zip
Merge branch 'master' of git.poez.io:poezio into slix
Conflicts: src/core/handlers.py src/tabs/xmltab.py
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/commands.rst6
-rw-r--r--doc/source/configuration.rst18
-rw-r--r--doc/source/dev/events.rst32
-rw-r--r--doc/source/keys.rst16
-rw-r--r--doc/source/usage.rst51
5 files changed, 92 insertions, 31 deletions
diff --git a/doc/source/commands.rst b/doc/source/commands.rst
index fc3aefa4..449d4095 100644
--- a/doc/source/commands.rst
+++ b/doc/source/commands.rst
@@ -541,10 +541,16 @@ XML tab commands
~~~~~~~~~~~~~~~~
.. glossary::
+ :sorted:
/clear [XML tab version]
Clear the current buffer.
+ /dump
+ **Usage:** ``/dump <filename>``
+
+ Write the content of the XML buffer into a file.
+
/reset
Reset the stanza filter.
diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst
index cb2fbddb..32d82f7a 100644
--- a/doc/source/configuration.rst
+++ b/doc/source/configuration.rst
@@ -62,8 +62,11 @@ and certificate validation.
**Default value:** ``[empty]``
- The fingerprint of the SSL certificate as a hexadecimal string, you should
- not touch it, except if know what you are doing.
+ The SHA-2 fingerprint of the SSL certificate as a hexadecimal string,
+ you should not touch it, except if know what you are doing.
+
+ .. note:: the fingerprint was previously stored in SHA-1, and has been
+ silently upgraded to SHA-2 if the SHA-1 still matched.
ciphers
@@ -194,6 +197,13 @@ Options related to account configuration, nickname…
The status message poezio will send when connecting.
+ open_all_bookmarks
+
+ **Default value:** ``false``
+
+ If this option is set to ``true``, all remote bookmarks, even
+ those that do not have autojoin, will be opened on startup.
+ (the tabs without autojoin will not be joined)
@@ -860,9 +870,11 @@ Other
remote_fifo_path
- **Default value:** ``./poezio.fifo``
+ **Default value:** ``./``
The path of the FIFO used to send the commands (see the :term:`exec_remote` option).
+ Poezio will try to create a :file:`poezio.fifo` file in this directory.
+
save_status
diff --git a/doc/source/dev/events.rst b/doc/source/dev/events.rst
index 7092d66b..770445a0 100644
--- a/doc/source/dev/events.rst
+++ b/doc/source/dev/events.rst
@@ -53,10 +53,11 @@ The following events are poezio-only events, for SleekXMPP events, check out
- **message:** :py:class:`~sleekxmpp.Message` that will be sent
- **tab:** :py:class:`~tabs.ConversationTab` source
- Same thing than :term:`conversation_say`, but after XHTML generation of the body, if needed.
- This means you must not insert any colors in the body in the handler, since
- it may lead to send invalid XML. This hook is less safe than :term:`conversation_say` and
- you should probably not need it.
+ Same thing than :term:`conversation_say`, but after XHTML generation
+ of the body, if needed. This means you must not insert any colors
+ in the body in the handler, since it may lead to send
+ invalid XML. This hook is less safe than :term:`conversation_say`
+ and you should probably not need it.
muc_msg
- **message:** :py:class:`~sleekxmpp.Message` received
@@ -96,7 +97,7 @@ The following events are poezio-only events, for SleekXMPP events, check out
normal_presence
- **presence:** :py:class:`~sleekxmpp.Presence` received
- - **resource:** :py:class:`Resource <str>` that emitted the :py:class:`~sleekxmpp.Presence`
+ - **resource:** :py:class:`Resource <str>` that emitted the :py:class:`~sleekxmpp.Presence`
Triggered when a presence is received from a contact.
@@ -104,18 +105,26 @@ The following events are poezio-only events, for SleekXMPP events, check out
- **presence:** :py:class:`~sleekxmpp.Presence` received
- **tab:** :py:class:`~tabs.MucTab` source
- Triggered when a presence is received from someone in a :py:class:`~tabs.MucTab`.
+ Triggered when a presence is received from someone in a
+ :py:class:`~tabs.MucTab`.
joining_muc
- **presence:** :py:class:`~~sleekxmpp.Presence` to be sent
+ Triggered when joining a MUC. The presence can thus be modified
+ before being sent.
+
+ changing_nick
+ - **presence:** :py:class:`~~sleekxmpp.Presence` to be sent
- Triggered when joining a MUC. The presence can thus be modified before being sent.
+ Triggered when the user changes his/her nickname on a MUC. The
+ presence can thus be modified before being sent.
send_normal_presence
- **presence:** :py:class:`~sleekxmpp.Presence` sent
- Triggered when poezio sends a new :py:class:`~sleekxmpp.Presence` stanza. The presence can thus be modified before being sent.
+ Triggered when poezio sends a new :py:class:`~sleekxmpp.Presence`
+ stanza. The presence can thus be modified before being sent.
muc_join
- **presence:** :py:class:`~sleekxmpp.Presence` received
@@ -148,7 +157,8 @@ The following events are poezio-only events, for SleekXMPP events, check out
- **message**:py:class:`~sleekxmpp.Message` received
- **tab:** :py:class:`~tabs.PrivateTab` source
- Triggered when a private message (that goes in a :py:class:`~tabs.PrivateTab`)
- is ignored automatically by poezio.
+ Triggered when a private message (that goes in a
+ :py:class:`~tabs.PrivateTab`) is ignored automatically by poezio.
- **tab** is always ``None``, except when a tab has already been opened.
+ **tab** is always ``None``, except when a tab has already been
+ opened.
diff --git a/doc/source/keys.rst b/doc/source/keys.rst
index d0b06eed..c590fffb 100644
--- a/doc/source/keys.rst
+++ b/doc/source/keys.rst
@@ -15,6 +15,8 @@ Key bindings listing
--------------------
Some key bindings are available only in some tabs, others are global.
+.. _global-keys:
+
Global keys
~~~~~~~~~~~
These keys work in **any** tab.
@@ -46,6 +48,8 @@ highlight > message > non-empty input).
**Alt-C**: Scroll the information buffer down.
+.. _input-keys:
+
Input keys
~~~~~~~~~~
These keys concern only the inputs.
@@ -75,9 +79,11 @@ for example in conjunction with the bind command, to help you know how to
bind something to a key combination without having to remember how to write
them by hand.
+.. _chattab-keys:
Chat tab input keys
~~~~~~~~~~~~~~~~~~~
+
These keys work in any conversation tab (MultiUserChat, Private or
Conversation tabs).
@@ -118,6 +124,8 @@ current conversation, if any.
- u: Underlined
- o: Stop formatting
+.. _muctab-keys:
+
MultiUserChat tab input keys
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -133,8 +141,11 @@ These keys work only in the MultiUserChat tab.
**tabulation**: Complete a nick.
+.. _muclisttab-keys:
+
MultiUserChat List tab input keys
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
These keys work only in the MultiUserChat List tab (obtained with :term:`/list`).
**Up**: Go up one row.
@@ -152,6 +163,8 @@ These keys work only in the MultiUserChat List tab (obtained with :term:`/list`)
**PageDown**: Scroll a page of chats down.
+.. _rostertab-keys:
+
Roster tab input keys
~~~~~~~~~~~~~~~~~~~~~
@@ -184,8 +197,11 @@ These keys work only in the Roster tab (the tab number 0).
**PageDown**: Scroll a page of contacts down.
+.. _forms-keys:
+
Data Forms tab keys
~~~~~~~~~~~~~~~~~~~
+
**Ctrl+y**: Validate the form, send it and close the tab.
**Ctrl+g**: Cancel that form (do not send your changes) and close the
diff --git a/doc/source/usage.rst b/doc/source/usage.rst
index c4d49fde..726198e3 100644
--- a/doc/source/usage.rst
+++ b/doc/source/usage.rst
@@ -8,13 +8,13 @@ Poezio is composed of tabs which can be of various types. Each tab type has
a distinct interface, list of commands and list of key shortcuts, in addition
to the global commands and key shortcuts.
-The Tab list
-~~~~~~~~~~~~
+Tab list
+~~~~~~~~
-Since Poezio 0.7.5, there are now two ways to show the available tabs:
+There are two ways of showing the open tabs:
-The old way: horizontal list
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Horizontal list
+^^^^^^^^^^^^^^^
This is the default method.
@@ -24,8 +24,8 @@ has a number, each time you open a new tab, it gets the next available number.
.. figure:: ./images/tab_bar.png
:alt: Example of 5 opened tabs
-The new way: vertical list
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+Vertical list
+^^^^^^^^^^^^^
On all tabs, you get a pane on the left side of the screen that shows a list
of the opened tabs. As stated above, each tab has a number, and each time you
@@ -57,6 +57,8 @@ Generalities
:ref:`global-commands`
+:ref:`Global shortcuts <global-keys>`
+
The tab numbered **0** is always the **roster** tab, the other tabs can be of any
type.
@@ -65,11 +67,11 @@ type.
The status of a tab is represented by its color:
-* **blue** (tab **0**): an inactive tab of any type, nothing new to see
+* **Blue** (tab **0**): an inactive tab of any type, nothing new to see
there.
-* **purple** (tab **1**): a :ref:`muctab` with at least one new
+* **Purple** (tab **1**): a :ref:`muctab` with at least one new
unread message.
-* **green** (tab **2**): a tab of a private conversation (:ref:`privatetab` or :ref:`conversationtab`)
+* **Green** (tab **2**): a tab of a private conversation (:ref:`privatetab` or :ref:`conversationtab`)
with a new message to read.
* **Cyan** (tab **3**): the current tab.
* **Red** (tab **4**): a :ref:`muctab` with at least one new highlight
@@ -92,19 +94,22 @@ Roster tab
:ref:`Specific commands <rostertab-commands>`
+:ref:`Specific shortcuts <rostertab-keys>`
+
This is a unique tab, always numbered **0**. It contains the list of your
-contacts. You can add/remove/edit/search contacts from there, and you can open
-a conversation with them.
+contacts. You can add (:term:`/add`, :term:`/accept`), remove
+(:term:`/remove`) and search contacts from there, and you can open
+a conversation with them (``Enter`` key).
-Use the **direction arrows** to browse the list, the ``Space`` key to fold or unfold a group
-or a contact.
+Use the **direction arrows** (↑↓) to browse the list, the ``Space`` key to
+fold or unfold a group or a contact.
.. figure:: ./images/roster.png
:alt: The roster tab
-#. The area where information messages are displayed.
-#. The actual list of contacts. The first level is group, the second is the
- contacts and the third is the resources of you online contacts.
+#. Area where information messages are displayed.
+#. Actual list of contacts. The first level is group, the second is the
+ contacts and the third is the resources of your online contacts.
#. More informations about the selected contact.
.. _muctab:
@@ -114,6 +119,10 @@ MultiUserChat tab
:ref:`Specific commands <muctab-commands>`
+:ref:`Specific shortcuts <muctab-keys>`
+
+:ref:`Chat shortcuts <chattab-keys>`
+
This tab contains a multi-user conversation.
.. figure:: ./images/muc.png
@@ -164,6 +173,8 @@ Private tab
~~~~~~~~~~~
:ref:`Specific commands <privatetab-commands>`
+:ref:`Chat shortcuts <chattab-keys>`
+
This is the tab opened with the :term:`/query` command in a :ref:`muctab`, letting you talk in private
with a participant of a multi-user chat.
@@ -180,6 +191,8 @@ Conversation tab
:ref:`Specific commands <conversationtab-commands>`
+:ref:`Chat shortcuts <chattab-keys>`
+
A tab opened from the roster or :term:`/message`, to talk in private with one of your contacts.
.. figure:: ./images/conversation.png
@@ -194,6 +207,8 @@ status message of the contact. Plugins may add some elements to the status line.
Dataforms tab
~~~~~~~~~~~~~
+:ref:`Specific shortcuts <formtab-keys>`
+
This tab lets you view a form received from a remote entity, edit the values and
send everything back. It is mostly used to configure MUCs with the
:term:`/configure` command but can actually be used for almost anything.
@@ -211,6 +226,8 @@ You can then send the completed form using ``Ctrl+y`` or cancel using ``Ctrl+g``
List tab
~~~~~~~~
+:ref:`Specific shortcuts <muclisttab-keys>`
+
This tab lists all public rooms on a MUC service (with the :term:`/list` command).
It is currently very limited but will be improved in the future. There currently
is no way to search a room.