From 718e2f3851744a54dac2028ff4ecc7897c1e0a13 Mon Sep 17 00:00:00 2001 From: mathieui Date: Tue, 8 Nov 2011 19:58:10 +0100 Subject: 80 cols. --- doc/en/usage.txt | 118 +++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 85 insertions(+), 33 deletions(-) diff --git a/doc/en/usage.txt b/doc/en/usage.txt index 7eb1b335..c77a8076 100644 --- a/doc/en/usage.txt +++ b/doc/en/usage.txt @@ -1,7 +1,8 @@ Usage ===== -This page is the main page of the documentation for poezio, explaining how to use it and describing its interfaces. +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 @@ -25,7 +26,13 @@ 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. +*/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 @@ -48,23 +55,40 @@ These commands work in *any* tab. */w *:: Like /win. -*/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.' +*/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 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). +*/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