From 662f9a7621308a21fbed96ca46cbac33848403f0 Mon Sep 17 00:00:00 2001 From: mathieui Date: Mon, 8 Apr 2013 19:17:32 +0200 Subject: Start migrating the command index --- doc/source/commands.rst | 306 +++++++++++++++++++++++++++++++++++++++++++++ doc/source/dev/theming.rst | 8 ++ doc/source/index.rst | 1 + doc/source/themes.rst | 4 +- 4 files changed, 317 insertions(+), 2 deletions(-) create mode 100644 doc/source/commands.rst create mode 100644 doc/source/dev/theming.rst (limited to 'doc/source') diff --git a/doc/source/commands.rst b/doc/source/commands.rst new file mode 100644 index 00000000..024dc3cc --- /dev/null +++ b/doc/source/commands.rst @@ -0,0 +1,306 @@ +Commands +======== + +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 described in this page are shown like this: + +.. code-block:: + + /command [optional argument] + +You can get the same help as below from inside poezio with the **/help** command. + +.. note:: Use command parameters like this: + + - Do not use quotes if they are unnecessary (words without special chars or spaces) + - 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 +~~~~~~~~~~~~~~~ + +These commands work in *any* tab. + +**/help [command]** + If called without an argument, this command will list the + available commands. If it has a valid command as an argument, this command + will show the usage and the help for the given command. + +**/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 and /quit** + Just disconnect from the server and exit poezio. + +.. _command-next: +**/next** + Go to the next room. + +.. _command-prev: +**/prev** + Go to the previous room. + +.. _command-win: +**/win or /w ** + Go to the specified room. + +.. _command-status: +**/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.' + +.. _command-bookmark: +**/bookmark [roomname][/nick] [autojoin] [password]** + Bookmark the specified + room. This command 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). You can specify an optional *autojoin* and *password* if you + call it with the full line (/bookmark alone will put the room in autojoin + without password). The bookmarks stored with this command are stored on your + xmpp server. + +.. _command-bookmark-local: +**/bookmark_local [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). The bookmarks stored + with this command will be stored locally. They have priority over the ones + stored online. + +.. _command-remove-bookmark: +**/remove_bookmark [room_jid]** + Remove the bookmark on *room_jid* or the one on the current tab, if any. + +.. _command-bookmarks: +**/bookmarks** + Show the current bookmarks. + +.. _command-set: +**/set [plugin|][section]