summaryrefslogtreecommitdiff
path: root/doc/source/commands.rst
diff options
context:
space:
mode:
authormathieui <mathieui@mathieui.net>2013-04-12 20:52:28 +0200
committermathieui <mathieui@mathieui.net>2013-04-12 20:52:28 +0200
commit975dcb4b6cb3391a34c1695965b285eadb6a0843 (patch)
treea949569ab1ed8aed53648022a8f05ecb32e4a831 /doc/source/commands.rst
parentfe16bd78cf71681f42762c3546c6efcd782fc026 (diff)
downloadpoezio-975dcb4b6cb3391a34c1695965b285eadb6a0843.tar.gz
poezio-975dcb4b6cb3391a34c1695965b285eadb6a0843.tar.bz2
poezio-975dcb4b6cb3391a34c1695965b285eadb6a0843.tar.xz
poezio-975dcb4b6cb3391a34c1695965b285eadb6a0843.zip
Add the usage help
Diffstat (limited to 'doc/source/commands.rst')
-rw-r--r--doc/source/commands.rst34
1 files changed, 24 insertions, 10 deletions
diff --git a/doc/source/commands.rst b/doc/source/commands.rst
index 6ef5ea1f..ad8eb7d0 100644
--- a/doc/source/commands.rst
+++ b/doc/source/commands.rst
@@ -1,15 +1,15 @@
Commands
========
-Commands start with the **/** character and can take a list of any number
+Commands start with the ``/`` character and can take a list of any number
of arguments, separated by spaces. If an argument should contain a space,
-you can use the **"** character to surround this argument.
+you can use the ``"`` character to surround this argument.
The commands described in this page are shown like this:
``/command <mandatory argument> [optional argument]``
-You can get the same help as below from inside poezio with the **/help** command.
+You can get the same help as below from inside poezio with the :term:`/help` command.
.. note:: Use command parameters like this:
@@ -17,6 +17,8 @@ You can get the same help as below from inside poezio with the **/help** command
- If the command takes several agrguments, you need to put quotes around arguments containing special chars such as backslashes or quotes
- If the command always takes only one argument, then do not use quotes even for words containing special chars
+.. _global-commands:
+
Global commands
~~~~~~~~~~~~~~~
@@ -164,7 +166,7 @@ These commands work in *any* tab.
/list
**Usage:** ``/list [server.tld]``
- Get the list of public chatrooms in the specified server
+ Get the list of public chatrooms in the specified server (open a :ref:`listtab`)
/message
**Usage:** ``/message <jid> [optional message]``
@@ -223,6 +225,8 @@ These commands work in *any* tab.
which can’t be closed.
+.. _chattab-commands:
+
Chat tab commands
~~~~~~~~~~~~~~~~~
@@ -252,6 +256,8 @@ These commands will work in any conversation tab (MultiUserChat, Private, or
/clear
Clear the current buffer.
+.. _muctab-commands:
+
MultiUserChat tab commands
~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -283,7 +289,7 @@ MultiUserChat tab commands
/query
**Usage:** ``/query <nick> [message]``
- Open a private conversation with <nick>. This nick
+ Open a :ref:`privatetab` with <nick>. This nick
has to be present in the room you’re currently in. If you specified a message
after the nickname, it will be sent to this user.
@@ -327,12 +333,14 @@ MultiUserChat tab commands
room or the given jid (usually its XMPP client and Operating System).
/configure
- Configure the current room through a form.
+ Configure the current room through a form (Open a :ref:`dataformtab`).
/names
Get the list of the users in the room, their number, and the list
of the people assuming different roles.
+.. _privatetab-commands:
+
Private tab commands
~~~~~~~~~~~~~~~~~~~~
@@ -349,6 +357,8 @@ Private tab commands
Get the software version of the current interlocutor (usually its
XMPP client and Operating System).
+.. _conversationtab-commands:
+
Normal Conversation tab commands
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -365,6 +375,8 @@ Normal Conversation tab commands
Get the software version of the current interlocutor (usually its
XMPP client and Operating System).
+.. _rostertab-commands:
+
Roster tab commands
~~~~~~~~~~~~~~~~~~~
.. glossary::
@@ -455,14 +467,16 @@ Roster tab commands
/export
**Usage:** ``/export [/path/to/file]``
- Export your contacts into /path/to/file if
- specified, or $HOME/poezio_contacts if not.
+ Export your contacts into :file:`/path/to/file` if
+ specified, or :file:`$HOME/poezio_contacts` if not.
/import
**Usage:** ``/import [/path/to/file]``
- Import your contacts from /path/to/file if
- specified, or $HOME/poezio_contacts if not.
+ Import your contacts from :file:`/path/to/file` if
+ specified, or :file:`$HOME/poezio_contacts` if not.
+
+.. _xmltab-commands:
XML tab commands
~~~~~~~~~~~~~~~~