poezio/doc/en/usage.txt
2011-11-08 19:38:50 +01:00

144 lines
6.4 KiB
Text
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Usage
=====
Commands
--------
Command listing
~~~~~~~~~~~~~~~
The commands are shown like this:
/command <mandatory argument> [optional argument]
Global commands
^^^^^^^^^^^^^^^
These commands work in *any* tab.
*/join [room_name][@server][/nick] [password]*:: Join the specified room. You can specify a nickname after a slash (/). If no nickname is specified, you will use the default_nick in the configuration file. You can omit the room name: you will then join the room you're looking at (useful if you were kicked). You can also provide a room_name without specifying a server, the server of the room you're currently in will be used. You can also provide a password to join the room.
- Examples:
* /join room@server.tld
* /join room@server.tld/John
* /join room2
* /join /me_again
* /join
* /join room@server.tld/my_nick password
* /join / password
*/exit*:: Just disconnect from the server and exit poezio.
*/quit*:: Like /exit.
*/next*:: Go to the next room.
*/prev*:: Go to the previous room.
*/win <number>*:: Go to the specified room.
*/w <number>*:: Like /win.
*/status <availability> [status message]*:: Set your availability and (optionaly) your status message. The <availability> 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).
*/set <option> [value]*:: Sets the value to the option in your configuration file. You can, for example, change your default nickname by doing "/set default_nick toto" or your resource with "/set resource blabla". You can also set an empty value (nothing) by providing no [value] after <option>.
*/theme*:: Reload the theme defined in the config file.
*/list [server.tld]*:: Get the list of public chatrooms in the specified server.
*/message <jid> [optional message]*:: Open a conversation with the specified JID (event if it is not in our roster), and send a message to him, if specified.
*/version <jid>*:: Get the software version of the given JID (usually its XMPP client and Operating System).
*/server_cycle [server.tld] [message]*:: Disconnect and reconnect in all the rooms of server.tld.
*/bind <key> <eq>*:: 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
^^^^^^^^^^^^^^^^^
These commands will work in any conversation tab (MultiUserChat, Private, or Conversation tabs).
*/say <message>*:: Just send the message (only useful it you want your message to begin with a "/").
MultiUserChat tab commands
^^^^^^^^^^^^^^^^^^^^^^^^^^
*/ignore <nickname>*:: Ignore a specified nickname.
*/unignore <nickname>*:: Remove the specified nickname from the ignore list.
*/kick <nick> [reason]*:: Kick the user with the specified nickname. You can also give an optional reason.
*/topic <subject>*:: Change the subject of the room. You might want to knwow that entering "/topic [tab]" will autocomplete the topic.
*/query <nick> [message]*:: Open a private conversation with <nick>. This nick has to be present in the room youre 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 <nickname>*:: 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 <nickname>*:: Display some information about the user in the room: his/her role, affiliation, status, and status message.
*/version <nickname or jid>*:: 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.
Private tab commands
^^^^^^^^^^^^^^^^^^^^
*/info*:: Display some info about this user in the MultiUserChat.
*/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.
*/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 <jid>*:: 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 doesnt, you can still /deny him).
*/name <jid> <name>*:: Set the given JIDs name.
*/groupadd <jid> <group>*:: Add the given JID to the given group (if the group does not exist, it will be created).
*/groupremove <jid> <group>*:: 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.