changeset 593:29d9a54ac69f

Update documentation
author Mikael Berthe <mikael@lilotux.net>
date Sun, 11 Dec 2005 11:34:31 +0100
parents 67a332121aea
children f791f5f0cfce
files mcabber/ChangeLog mcabber/TODO mcabber/doc/mcabber.1 mcabber/doc/mcabber.1.html mcabber/doc/mcabber.1.txt
diffstat 5 files changed, 58 insertions(+), 37 deletions(-) [+]
line wrap: on
line diff
--- a/mcabber/ChangeLog	Sun Dec 11 11:11:34 2005 +0100
+++ b/mcabber/ChangeLog	Sun Dec 11 11:34:31 2005 +0100
@@ -6,7 +6,9 @@
  * MUC: "/room topic" shows the current room topic
  * MUC: "/room nick" shows the current nickname
  * MUC: Add "/room kick", "/room ban", "/room whois"
- * MUC: Multiple small fixes and improvements
+ * MUC: Add "/room affil" and "/room role"
+ * MUC: Display a message when somebody is kicked/banned from a room
+ * MUC: Multiple fixes and improvements
  * Handle messages beginning with "/me " (it is replaced with the nickname)
 
  -- Mikael, ?
--- a/mcabber/TODO	Sun Dec 11 11:11:34 2005 +0100
+++ b/mcabber/TODO	Sun Dec 11 11:34:31 2005 +0100
@@ -1,8 +1,6 @@
 
 BUGS:
 
-* /status_to, /say_to, and "/room privmsg" do not deal with resources
-  containing spaces
 * The PgUp and Ins keys do not work for some people
   Cannot reproduce, any help appreciated.
 * mcabber does not work with gnutls
@@ -27,12 +25,12 @@
 * Persistent room in the roster (join every connect)
 * MUC: advanced settings for room creation
 * MUC: join password-protected room
-* MUC: tell the user when (s)he's been kicked/banned
 
 * File transfer? :)
 
 * Commands:
 
+  - /room destroy
   - /group expand|shrink|toggle
     + rename
   - /info [jid]
--- a/mcabber/doc/mcabber.1	Sun Dec 11 11:11:34 2005 +0100
+++ b/mcabber/doc/mcabber.1	Sun Dec 11 11:34:31 2005 +0100
@@ -205,10 +205,7 @@
 \fB/room\fR
 The room command handles Multi\-User Chat room actions\&.
 
- \fBban\fR jid [reason]   	ban jid from the current room
- \fBinvite\fR jid [reason]	invite jid to the current room
  \fBjoin\fR room nick     	join "room", using "nick" as nickname
- \fBkick\fR nick [reason] 	kick "nick" from the current room
  \fBleave\fR [message]    	leave the current room
  \fBnames\fR              	display members of the current room
  \fBnick\fR nick          	change your nickname in the current room
@@ -218,6 +215,12 @@
  \fBunlock\fR             	unlock current room (if you are the owner)
  \fBwhois\fR nick         	display MUC information about "nick"
 
+ \fBinvite\fR jid [reason]	invite jid to the current room
+ \fBkick\fR nick [reason] 	kick "nick" from the current room
+ \fBban\fR jid [reason]   	ban jid from the current room
+ \fBrole\fR jid role [reason]	change jid's role (role can be "none", "visitor", "participant", "moderator")
+ \fBaffil\fR jid affil [reason]	change jid's affiliation (affil can be "none", "member", "admin", "owner")
+
 .TP
 \fB/roster\fR
 The roster command manipulates the roster/buddylist\&.  Here are the available parameters:
--- a/mcabber/doc/mcabber.1.html	Sun Dec 11 11:11:34 2005 +0100
+++ b/mcabber/doc/mcabber.1.html	Sun Dec 11 11:34:31 2005 +0100
@@ -459,29 +459,13 @@
 /room join|leave|names|nick|privmsg|remove|topic|unlock
 </b></dt>
 <dt><b>
-/room invite|kick|ban
+/room invite|kick|ban|role|affil
 </b></dt>
 <dd>
         The <b>room</b> command handles Multi-User Chat room actions.
 <table class="hlist">
 <tr valign="top">
 <td>
-<b>ban</b> jid [reason]
-</td>
-<td>
-ban jid from the current room
-</td>
-</tr>
-<tr valign="top">
-<td>
-<b>invite</b> jid [reason]
-</td>
-<td>
-invite jid to the current room
-</td>
-</tr>
-<tr valign="top">
-<td>
 <b>join</b> room nick
 </td>
 <td>
@@ -490,14 +474,6 @@
 </tr>
 <tr valign="top">
 <td>
-<b>kick</b> nick [reason]
-</td>
-<td>
-kick "nick" from the current room
-</td>
-</tr>
-<tr valign="top">
-<td>
 <b>leave</b> [message]
 </td>
 <td>
@@ -560,6 +536,46 @@
 display MUC information about "nick"
 </td>
 </tr>
+<tr valign="top">
+<td>
+<b>ban</b> jid [reason]
+</td>
+<td>
+ban jid from the current room
+</td>
+</tr>
+<tr valign="top">
+<td>
+<b>invite</b> jid [reason]
+</td>
+<td>
+invite jid to the current room
+</td>
+</tr>
+<tr valign="top">
+<td>
+<b>kick</b> nick [reason]
+</td>
+<td>
+kick "nick" from the current room
+</td>
+</tr>
+<tr valign="top">
+<td>
+<b>role</b> jid role [reason]
+</td>
+<td>
+change jid's role (role can be "none", "visitor", "participant", "moderator")
+</td>
+</tr>
+<tr valign="top">
+<td>
+<b>affil</b> jid affil [reason]
+</td>
+<td>
+change jid's affiliation (affil can be "none", "member", "admin", "owner")
+</td>
+</tr>
 </table>
 </dd>
 <dt><b>
@@ -726,7 +742,7 @@
 <div id="footer">
 <p>
 Version 0.7.2-dev<br />
-Last updated 03-Dec-2005 23:50:16 CEST
+Last updated 11-Dec-2005 11:17:53 CEST
 </p>
 </div>
 </div>
--- a/mcabber/doc/mcabber.1.txt	Sun Dec 11 11:11:34 2005 +0100
+++ b/mcabber/doc/mcabber.1.txt	Sun Dec 11 11:34:31 2005 +0100
@@ -181,13 +181,10 @@
         the buddies to another group with the "/move" command).
 
 /room join|leave|names|nick|privmsg|remove|topic|unlock::
-/room invite|kick|ban::
+/room invite|kick|ban|role|affil::
         The 'room' command handles Multi-User Chat room actions.
 
-        'ban' jid [reason];;    ban jid from the current room
-        'invite' jid [reason];; invite jid to the current room
         'join' room nick;;      join "room", using "nick" as nickname
-        'kick' nick [reason];;  kick "nick" from the current room
         'leave' [message];;     leave the current room
         'names';;               display members of the current room
         'nick' nick;;           change your nickname in the current room
@@ -196,6 +193,11 @@
         'topic';;               set topic for current room
         'unlock';;              unlock current room (if you are the owner)
         'whois' nick;;          display MUC information about "nick"
+        'ban' jid [reason];;    ban jid from the current room
+        'invite' jid [reason];; invite jid to the current room
+        'kick' nick [reason];;  kick "nick" from the current room
+        'role' jid role [reason];;  change jid's role (role can be "none", "visitor", "participant", "moderator")
+        'affil' jid affil [reason];; change jid's affiliation (affil can be "none", "member", "admin", "owner")
 
 /roster bottom|top|hide_offline|show_offline|toggle_offline::
 /roster alternate|unread_first|unread_next::