From 2f5d7124676fb1e32a0223bd968d671ac2f38333 Mon Sep 17 00:00:00 2001 From: mathieui Date: Tue, 8 Nov 2011 19:10:19 +0100 Subject: Doc: ChatTab and MUC commands --- doc/en/usage.txt | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) (limited to 'doc/en/usage.txt') diff --git a/doc/en/usage.txt b/doc/en/usage.txt index be6809ba..216e4852 100644 --- a/doc/en/usage.txt +++ b/doc/en/usage.txt @@ -57,3 +57,43 @@ These commands work in *any* tab. */bind *:: Bind a key to another key or to a "command". For example, "/bind ^H KEY_UP" makes Control + h behave the same way than the Up key. +Chat tab commands +^^^^^^^^^^^^^^^^^ + +These commands will work in any conversation tab (MultiUserChat, Private, or Conversation tabs). + +*/say *:: Just send the message (only useful it you want your message to begin with a "/"). + +MultiUserChat tab commands +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +*/ignore *:: Ignore a specified nickname. + +*/unignore *:: Remove the specified nickname from the ignore list. + +*/kick [reason]*:: Kick the user with the specified nickname. You can also give an optional reason. + +*/topic *:: Change the subject of the room. You might want to knwow that entering "/topic [tab]" will autocomplete the topic. + +*/query [message]*:: Open a private conversation with . 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. + +*/part [message]*:: Disconnect you from a room. You can specify an optional message. + +*/close [message]*:: Disconnect you from a room (if you are connected) and close the tab. You can specify an optional message if you are still connected. + +*/nick *:: Change your nickname in the current room. + +*/recolor*:: Re-assign a color to all the participants in the current room, based on the last time they talked. Use this if the participants currently talking have too many identical colors. + +*/cycle [message]*:: Leave the current room an rejoint it immediatly. You can specify an optional quit message. + +*/info *:: Display some information about the user in the room: his/her role, affiliation, status, and status message. + +*/version *:: Get the software version of the given nick in room or the given jid (usually its XMPP client and Operating System). + +*/configure*:: Configure the current room through a form. + +*/names*:: Get the list of the users in the room, their number, and the list of the people assuming different roles. + +*/clear*:: Clear the current buffer. + -- cgit v1.2.3 From 6779f7c7a46840b6323280596701cc7606f04a31 Mon Sep 17 00:00:00 2001 From: mathieui Date: Tue, 8 Nov 2011 19:17:38 +0100 Subject: Doc: PrivateTab and ConversationTab commands --- doc/en/usage.txt | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) (limited to 'doc/en/usage.txt') diff --git a/doc/en/usage.txt b/doc/en/usage.txt index 216e4852..872ff0eb 100644 --- a/doc/en/usage.txt +++ b/doc/en/usage.txt @@ -97,3 +97,25 @@ MultiUserChat tab commands */clear*:: Clear the current buffer. +Private tab commands +^^^^^^^^^^^^^^^^^^^^ + +*/info*:: Display some info about this user in the MultiUserChat. + +*/close*:: Close the tab. + +*/unquery*:: Close the tab. + +*/version*:: Get the software version of the current interlocutor (usually its XMPP client and Operating System). + +Normal Conversation tab commands +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +*/info*:: Display the status of this contact. + +*/close*:: Close the tab. + +*/unquery*:: Close the tab. + +*/version*:: Get the software version of the current interlocutor (usually its XMPP client and Operating System). + -- cgit v1.2.3 From 696ce0f283ea95ddb88705c161691e2fa80c13b8 Mon Sep 17 00:00:00 2001 From: mathieui Date: Tue, 8 Nov 2011 19:38:50 +0100 Subject: Doc: Roster tab commands --- doc/en/usage.txt | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) (limited to 'doc/en/usage.txt') diff --git a/doc/en/usage.txt b/doc/en/usage.txt index 872ff0eb..e00b88de 100644 --- a/doc/en/usage.txt +++ b/doc/en/usage.txt @@ -57,6 +57,10 @@ These commands work in *any* tab. */bind *:: Bind a key to another key or to a "command". For example, "/bind ^H KEY_UP" makes Control + h behave the same way than the Up key. +NOTE: The following command will work everywhere, except in the Roster tab. + +*/close*:: Close the tab. + Chat tab commands ^^^^^^^^^^^^^^^^^ @@ -102,8 +106,6 @@ Private tab commands */info*:: Display some info about this user in the MultiUserChat. -*/close*:: Close the tab. - */unquery*:: Close the tab. */version*:: Get the software version of the current interlocutor (usually its XMPP client and Operating System). @@ -113,9 +115,30 @@ Normal Conversation tab commands */info*:: Display the status of this contact. -*/close*:: Close the tab. - */unquery*:: Close the tab. */version*:: Get the software version of the current interlocutor (usually its XMPP client and Operating System). +Roster tab commands +^^^^^^^^^^^^^^^^^^^ + +*/accept [jid]*:: Authorize the provided JID (or the selected contact in the roster) to see your presence. + +*/deny [jid]*:: Prevent the provided JID (or the selected contact in the roster) from seeing your presence. + +*/add *:: Add the specified JID to your roster and authorize him to see your presence. If he accepts you, the subscription will be mutual (and if he doesn’t, you can still /deny him). + +*/name *:: Set the given JID’s name. + +*/groupadd *:: Add the given JID to the given group (if the group does not exist, it will be created). + +*/groupremove *:: Remove the given JID from the given group (if the group is empty after that, it will get deleted). + +*/remove [jid]*:: Remove the specified JID from your roster. TThis will unsubscribe you from its presence, cancel it subscription to yours, and remove the item from your roster. + +NOTE: The following commands do not comply with any XEP or whatever, but they can still prove useful when you are migrating to an other JID. + +*/export [/path/to/file]*:: Export your contacts into /path/to/file if specified, or $HOME/poezio_contacts if not. + +*/import [/path/to/file]*:: Import your contacts from /path/to/file if specified, or $HOME/poezio_contacts if not. + -- cgit v1.2.3 From d28b70ccd4a29c6ef5b0f7f740ac04b4348669b4 Mon Sep 17 00:00:00 2001 From: Florent Le Coz Date: Tue, 8 Nov 2011 19:39:12 +0100 Subject: Some documentation improvements. --- doc/en/usage.txt | 31 ++++++++++++++++++++----------- 1 file changed, 20 insertions(+), 11 deletions(-) (limited to 'doc/en/usage.txt') diff --git a/doc/en/usage.txt b/doc/en/usage.txt index e00b88de..e7df6ce8 100644 --- a/doc/en/usage.txt +++ b/doc/en/usage.txt @@ -1,18 +1,27 @@ Usage ===== +This page is the main page of the documentation for poezio, explaining how to use it and describing its interfaces. + +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. + Commands -------- -Command listing -~~~~~~~~~~~~~~~ +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. -The commands are shown like this: +The commands described in this page are shown like this: +=========================================================== /command [optional argument] +=========================================================== Global commands -^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~ These commands work in *any* tab. @@ -41,7 +50,7 @@ These commands work in *any* tab. */status [status message]*:: Set your availability and (optionaly) your status message. The argument is one of "available, chat, away, afk, dnd, busy, xa" and the optional [status] argument will be your status message.' -*/bookmark [roomname][/nick]*:: Bookmark the specified room (you will then auto-join it on each poezio start). This commands uses the same syntax as /join. Type /help join for syntax examples. Note that when typing /bookmark on its own, the room will be bookmarked with the nickname you're currently using in this room (instead of default_nick). +*/bookmark [roomname][/nick]*:: Bookmark the specified room (you will then auto-join it on each poezio start). This commands uses almost the same syntax as /join. Type /help join for syntax examples. Note that when typing /bookmark on its own, the room will be bookmarked with the nickname you're currently using in this room (instead of default_nick). */set