changeset 660:ef7f0b58a159

Update documentation
author Mikael Berthe <mikael@lilotux.net>
date Sun, 08 Jan 2006 22:26:02 +0100
parents e61aa455c61b
children 4674e92a3e01
files mcabber/doc/mcabber.1 mcabber/doc/mcabber.1.html mcabber/doc/mcabber.1.txt
diffstat 3 files changed, 14 insertions(+), 10 deletions(-) [+]
line wrap: on
line diff
--- a/mcabber/doc/mcabber.1	Sun Jan 08 01:25:58 2006 +0100
+++ b/mcabber/doc/mcabber.1	Sun Jan 08 22:26:02 2006 +0100
@@ -121,7 +121,7 @@
 
 .TP
 \fB/add\fR [jid [nickname]]
-Add the "jid" Jabber user to our roster (default group), and send a notification request to this buddy\&. If no nickname is specified, the jid is used\&. If no jid is provided (or jid is empty ""), the current buddy is used\&.
+Add the "jid" Jabber user to our roster (default group), and send a notification request to this buddy\&. If no nickname is specified, the jid is used\&. If no jid (or an empty string "") is provided or if jid is "\&.", the current buddy is used\&.
 
 .TP
 \fB/alias\fR name = command line
@@ -224,7 +224,7 @@
 \fB/room\fR
 The room command handles Multi\-User Chat room actions\&.
 
- \fBjoin\fR room nick     	join "room", using "nick" as nickname
+ \fBjoin\fR room nick     	join "room", using "nick" as nickname\&. If no nickname is provided, the "nickname" option value is used (see sample configuration file)
  \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
@@ -277,6 +277,8 @@
 \fB/status_to\fR jid online|avail|invisible|free|dnd|notavail|away [StatusMessage]
 Send the requested status to the specified Jabber user\&.
 
+If the specified jid is "\&.", the current buddy is used\&.
+
 Note: this status will be overridden by subsequent "/status" commands\&. If you are using the auto\-away feature, the status will overridden too\&.
 
 Note: The jid can include a resource (i\&.e\&. user@server/resource)\&.
--- a/mcabber/doc/mcabber.1.html	Sun Jan 08 01:25:58 2006 +0100
+++ b/mcabber/doc/mcabber.1.html	Sun Jan 08 22:26:02 2006 +0100
@@ -220,8 +220,8 @@
 <dd>
         Add the "jid" Jabber user to our roster (default group), and send a
         notification request to this buddy.  If no nickname is specified, the
-        jid is used.  If no jid is provided (or jid is empty ""), the
-        current buddy is used.
+        jid is used.  If no jid (or an empty string "") is provided or if jid
+        is ".", the current buddy is used.
 </dd>
 <dt><b>
 /alias name = command line
@@ -524,10 +524,10 @@
 <table class="hlist">
 <tr valign="top">
 <td>
-<b>join</b> room nick
+<b>join</b> room [nick]
 </td>
 <td>
-join "room", using "nick" as nickname
+join "room", using "nick" as nickname.  If no nickname is provided, the "nickname" option value is used (see sample configuration file)
 </td>
 </tr>
 <tr valign="top">
@@ -779,6 +779,7 @@
 </b></dt>
 <dd>
         Send the requested status to the specified Jabber user.<br />
+        If the specified jid is ".", the current buddy is used.<br />
         Note: this status will be overridden by subsequent "/status" commands.
         If you are using the auto-away feature, the status will overridden
         too.<br />
@@ -814,7 +815,7 @@
 <div id="footer">
 <p>
 Version 0.7.3-dev<br />
-Last updated 28-Dec-2005 11:02:09 CEST
+Last updated 08-Jan-2006 22:19:10 CEST
 </p>
 </div>
 </div>
--- a/mcabber/doc/mcabber.1.txt	Sun Jan 08 01:25:58 2006 +0100
+++ b/mcabber/doc/mcabber.1.txt	Sun Jan 08 22:26:02 2006 +0100
@@ -92,8 +92,8 @@
 /add [jid [nickname]]::
         Add the "jid" Jabber user to our roster (default group), and send a
         notification request to this buddy.  If no nickname is specified, the
-        jid is used.  If no jid is provided (or jid is empty ""), the
-        current buddy is used.
+        jid is used.  If no jid (or an empty string "") is provided or if jid
+        is ".", the current buddy is used.
 
 /alias name = command line::
         Add "name" as an alias for "command line". +
@@ -200,7 +200,7 @@
 /room invite|kick|ban|role|affil::
         The 'room' command handles Multi-User Chat room actions.
 
-        'join' room nick;;      join "room", using "nick" as nickname
+        'join' room [nick];;    join "room", using "nick" as nickname.  If no nickname is provided, the "nickname" option value is used (see sample configuration file)
         'leave' [message];;     leave the current room
         'names';;               display members of the current room
         'nick' nick;;           change your nickname in the current room
@@ -254,6 +254,7 @@
 
 /status_to jid online|avail|invisible|free|dnd|notavail|away [StatusMessage]::
         Send the requested status to the specified Jabber user. +
+        If the specified jid is ".", the current buddy is used. +
         Note: this status will be overridden by subsequent "/status" commands.
         If you are using the auto-away feature, the status will overridden
         too. +