Update manual page
* Add /room and /status_to documentation
* Some other corrections
--- a/mcabber/doc/mcabber.1 Sun Sep 25 23:45:34 2005 +0200
+++ b/mcabber/doc/mcabber.1 Mon Sep 26 00:24:22 2005 +0200
@@ -114,11 +114,21 @@
.TP
\fB/alias\fR name = command line
-Add "name" as an alias for "command line"\&. Aliases are expanded only once, thus they can not be chained\&. "/alias name" displays the value associated with the "name" alias; "/alias name =" unsets the "name" alias\&. Example: "/alias away = status away"\&.
+Add "name" as an alias for "command line"\&.
+
+Aliases are expanded only once, thus they can not be chained\&. "/alias name" displays the value associated with the "name" alias; "/alias name =" unsets the "name" alias\&.
+
+Example: "/alias away = status away"\&.
.TP
\fB/bind\fR keycode = command line
-Bind a command line to the key with the "keycode" code number\&. Keycodes of unused keys are displayed by mcabber in the log window when pressing the key, for example "Unknown key=265"\&. "/bind keycode" displays the command line bound to the given keycode; "/bind keycode" unbinds the given keycode\&. Note: aliases can be used in key bindings\&. Example: "/bind 265 = status online" (265 is F1 for me, but it can depend on your ncurses installation)\&.
+Bind a command line to the key with the "keycode" code number\&.
+
+Keycodes of unused keys are displayed by mcabber in the log window when pressing the key, for example "Unknown key=265"\&. "/bind keycode" displays the command line bound to the given keycode; "/bind keycode" unbinds the given keycode\&.
+
+Note: aliases can be used in key bindings\&.
+
+Example: "/bind 265 = status online" (265 is F1 for me, but it may depend on your ncurses installation)\&.
.TP
\fB/buffer\fR clear|top|bottom|search_backward|search_forward
@@ -164,7 +174,11 @@
.TP
\fB/msay\fR begin|verbatim|send|abort
-Send a multi\-line message\&. To write a single message with several lines, the \fImulti\-line mode\fR should be used\&. In multi\-line mode, each line (except command lines) typed in the input line will be added to the multi\-line message\&. Once the message is finished, it can be sent to the current selected buddy with the "msay /send" command\&. The \fIverbatim\fR multi\-line mode disables commands, so that it is possible to enter lines starting with a slash\&. Only the "/msay" command (with send or abort parameters) can be used to exit verbatim mode\&.
+Send a multi\-line message\&. To write a single message with several lines, the \fImulti\-line mode\fR should be used\&.
+
+In multi\-line mode, each line (except command lines) typed in the input line will be added to the multi\-line message\&. Once the message is finished, it can be sent to the current selected buddy with the "/msay send" command\&.
+
+The \fIverbatim\fR multi\-line mode disables commands, so that it is possible to enter lines starting with a slash\&. Only the "/msay" command (with send or abort parameters) can be used to exit verbatim mode\&.
\fBbegin\fR enter multi\-line mode
\fBverbatim\fR enter verbatim multi\-line mode
@@ -177,7 +191,17 @@
.TP
\fB/rename\fR nickname
-Rename current buddy to the given nickname\&. This command does not work for groups, at the moment (but you can move the buddies to another group with the /move command)\&.
+Rename current buddy to the given nickname\&. This command does not work for groups, at the moment (but you can move the buddies to another group with the "/move" command)\&.
+
+
+.TP
+\fB/room\fR join|leave|names|remove
+The room command handles Multi\-User Chat room actions\&.
+
+ \fBjoin\fR room nick join "room", using "nick" as nickname
+ \fBleave\fR leave the current room
+ \fBnames\fR display members of the current room
+ \fBremove\fR remove the current room from the roster\&. You must have left this room before\&.
.TP
\fB/roster\fR
@@ -203,6 +227,14 @@
\fB/status\fR [online|avail|invisible|free|dnd|notavail|away [StatusMessage]]
Set the current status\&. If no status is specified, display the current status\&. If a status message is specified, it will overrride the message* variables\&.
+.TP
+\fB/status_to\fR jid online|avail|invisible|free|dnd|notavail|away [StatusMessage]
+Send the requested status to the specified Jabber user\&.
+
+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)\&.
+
.SH "CONFIGURATION FILE"
--- a/mcabber/doc/mcabber.1.html Sun Sep 25 23:45:34 2005 +0200
+++ b/mcabber/doc/mcabber.1.html Mon Sep 26 00:24:22 2005 +0200
@@ -220,7 +220,7 @@
"/bind keycode" displays the command line bound to the given keycode;
"/bind keycode" unbinds the given keycode.<br />
Note: aliases can be used in key bindings.<br />
- Example: "/bind 265 = status online" (265 is F1 for me, but it can
+ Example: "/bind 265 = status online" (265 is F1 for me, but it may
depend on your ncurses installation).
</dd>
<dt><b>
@@ -355,8 +355,8 @@
lines, the <b>multi-line mode</b> should be used.<br />
In multi-line mode, each line (except command lines) typed in the input
line will be added to the multi-line message. Once the message is
- finished, it can be sent to the current selected buddy with the "msay
- /send" command.<br />
+ finished, it can be sent to the current selected buddy with the "/msay
+ send" command.<br />
The <b>verbatim</b> multi-line mode disables commands, so that it is
possible to enter lines starting with a slash. Only the "/msay"
command (with send or abort parameters) can be used to exit verbatim
@@ -414,7 +414,47 @@
<dd>
Rename current buddy to the given nickname.
This command does not work for groups, at the moment (but you can move
- the buddies to another group with the /move command).
+ the buddies to another group with the "/move" command).
+</dd>
+<dt><b>
+/room join|leave|names|remove
+</b></dt>
+<dd>
+ The <b>room</b> command handles Multi-User Chat room actions.
+<table class="hlist">
+<tr valign="top">
+<td>
+<b>join</b> room nick
+</td>
+<td>
+join "room", using "nick" as nickname
+</td>
+</tr>
+<tr valign="top">
+<td>
+<b>leave</b>
+</td>
+<td>
+leave the current room
+</td>
+</tr>
+<tr valign="top">
+<td>
+<b>names</b>
+</td>
+<td>
+display members of the current room
+</td>
+</tr>
+<tr valign="top">
+<td>
+<b>remove</b>
+</td>
+<td>
+remove the current room from the roster. You must have left this room before.
+</td>
+</tr>
+</table>
</dd>
<dt><b>
/roster bottom|top|hide_offline|show_offline|toggle_offline
@@ -534,6 +574,16 @@
If a status message is specified, it will overrride the message*
variables.
</dd>
+<dt><b>
+/status_to jid online|avail|invisible|free|dnd|notavail|away [StatusMessage]
+</b></dt>
+<dd>
+ Send the requested status to the specified Jabber user.<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 />
+ Note: The jid can include a resource (i.e. user@server/resource).
+</dd>
</dl>
<h2>CONFIGURATION FILE</h2>
<p>See the provided sample configuration file, which should be self-documented.</p>
@@ -558,7 +608,7 @@
<div id="footer">
<p>
Version 0.6.9-dev<br />
-Last updated 20-Sep-2005 23:15:49 CEST
+Last updated 26-Sep-2005 00:06:42 CEST
</p>
</div>
</div>
--- a/mcabber/doc/mcabber.1.txt Sun Sep 25 23:45:34 2005 +0200
+++ b/mcabber/doc/mcabber.1.txt Mon Sep 26 00:24:22 2005 +0200
@@ -100,7 +100,7 @@
"/bind keycode" displays the command line bound to the given keycode;
"/bind keycode" unbinds the given keycode. +
Note: aliases can be used in key bindings. +
- Example: "/bind 265 = status online" (265 is F1 for me, but it can
+ Example: "/bind 265 = status online" (265 is F1 for me, but it may
depend on your ncurses installation).
/buffer clear|top|bottom|search_backward|search_forward::
@@ -150,8 +150,8 @@
lines, the 'multi-line mode' should be used. +
In multi-line mode, each line (except command lines) typed in the input
line will be added to the multi-line message. Once the message is
- finished, it can be sent to the current selected buddy with the "msay
- /send" command. +
+ finished, it can be sent to the current selected buddy with the "/msay
+ send" command. +
The 'verbatim' multi-line mode disables commands, so that it is
possible to enter lines starting with a slash. Only the "/msay"
command (with send or abort parameters) can be used to exit verbatim
@@ -171,7 +171,15 @@
/rename nickname::
Rename current buddy to the given nickname.
This command does not work for groups, at the moment (but you can move
- the buddies to another group with the /move command).
+ the buddies to another group with the "/move" command).
+
+/room join|leave|names|remove::
+ The 'room' command handles Multi-User Chat room actions.
+
+ 'join' room nick;; join "room", using "nick" as nickname
+ 'leave';; leave the current room
+ 'names';; display members of the current room
+ 'remove';; remove the current room from the roster. You must have left this room before.
/roster bottom|top|hide_offline|show_offline|toggle_offline::
/roster alternate|unread_first|unread_next::
@@ -200,6 +208,13 @@
If a status message is specified, it will overrride the message*
variables.
+/status_to jid online|avail|invisible|free|dnd|notavail|away [StatusMessage]::
+ Send the requested status to the specified Jabber user. +
+ 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).
+
CONFIGURATION FILE
------------------
See the provided sample configuration file, which should be self-documented.