diff mcabber/doc/mcabber.1 @ 450:fa93f47a08fe

Update manual page * Add /room and /status_to documentation * Some other corrections
author Mikael Berthe <mikael@lilotux.net>
date Mon, 26 Sep 2005 00:24:22 +0200
parents 264f40222872
children 52171a3dc199
line wrap: on
line diff
--- 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"