changeset 491:28f67990ce7b

Update manual page
author Mikael Berthe <mikael@lilotux.net>
date Sat, 08 Oct 2005 00:29:37 +0200
parents af6e31e32d9e
children 0bda46fa3e81
files mcabber/doc/mcabber.1 mcabber/doc/mcabber.1.html mcabber/doc/mcabber.1.txt
diffstat 3 files changed, 38 insertions(+), 28 deletions(-) [+]
line wrap: on
line diff
--- a/mcabber/doc/mcabber.1	Sat Oct 08 00:29:02 2005 +0200
+++ b/mcabber/doc/mcabber.1	Sat Oct 08 00:29:37 2005 +0200
@@ -113,7 +113,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\&.
+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\&.
 
 .TP
 \fB/alias\fR name = command line
@@ -137,13 +137,13 @@
 \fB/buffer\fR clear|top|bottom|search_backward|search_forward
 The buffer command manipulates the current buddy's buffer (chat window)\&.
 
- \fBclear\fR    	clear the current buddy chat window
- \fBtop\fR      	jump to the top of the current buddy chat buffer
- \fBbottom\fR   	jump to the bottom of the current buddy chat buffer
- \fBsearch_backward\fR text	search for text in the current buddy chat buffer
- \fBsearch_forward\fR  text	search for text in the current buddy chat buffer
- \fBdate\fR date	jump to the first line after the specified date in the chat buffer (date format: "YYYY\-mm\-dd[THH:MM:SS]", "\-" and ":" are optional)
- \fB%\fR n      	jump to position %n of the buddy chat buffer
+ \fBclear\fR               	clear the current buddy chat window
+ \fBtop\fR                 	jump to the top of the current buddy chat buffer
+ \fBbottom\fR              	jump to the bottom of the current buddy chat buffer
+ \fBsearch_backward\fR text	search for "text" in the current buddy chat buffer
+ \fBsearch_forward\fR  text	search for "text" in the current buddy chat buffer
+ \fBdate\fR date           	jump to the first line after the specified date in the chat buffer (date format: "YYYY\-mm\-dd[THH:MM:SS]", "\-" and ":" are optional)
+ \fB%\fR n                 	jump to position %n of the buddy chat buffer
 
 .TP
 \fB/clear\fR
@@ -200,7 +200,7 @@
 
 
 .TP
-\fB/room\fR join|leave|names|remove|topic|unlock
+\fB/room\fR invite|join|leave|names|nick|privmsg|remove|topic|unlock
 The room command handles Multi\-User Chat room actions\&.
 
  \fBinvite\fR jid [reason]	invite jid to the current room
@@ -208,6 +208,7 @@
  \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
+ \fBprivmsg\fR nick msg   	send private message "msg" to "nick"
  \fBremove\fR             	remove the current room from the roster (you must have left this room before)
  \fBtopic\fR              	set topic for current room
  \fBunlock\fR             	unlock current room (if you are the owner)
@@ -216,10 +217,10 @@
 \fB/roster\fR
 The roster command manipulates the roster/buddylist\&.  Here are the available parameters:
 
- \fBbottom\fR     	jump to the bottom of the roster
- \fBtop\fR        	jump to the top of the roster
- \fBup\fR         	move up in the roster
- \fBdown\fR       	move down in the roster
+ \fBbottom\fR    	jump to the bottom of the roster
+ \fBtop\fR       	jump to the top of the roster
+ \fBup\fR        	move up in the roster
+ \fBdown\fR      	move down in the roster
  \fBhide_offline\fR	hide offline buddies
  \fBshow_offline\fR	show offline buddies
  \fBtoggle_offline\fR	toggle display of offline buddies
@@ -230,11 +231,11 @@
 
 .TP
 \fB/say\fR text
-Send the text message to the currently selected buddy\&. Can be useful if you want to send a message beginning with a slash, for example\&.
+Send the "text" message to the currently selected buddy\&. Can be useful if you want to send a message beginning with a slash, for example\&.
 
 .TP
 \fB/say_to\fR jid text
-Send the text message to the specified jid\&. Please note that this command doesn't set the default resource for a contact, so if you want to send several messages to a specific ressource you will have to use "/say_to" for each message\&.
+Send the "text" message to the specified jid\&. Please note that this command doesn't set the default resource for a contact, so if you want to send several messages to a specific ressource you will have to use "/say_to" for each message\&.
 
 .TP
 \fB/status\fR [online|avail|invisible|free|dnd|notavail|away [StatusMessage]]
--- a/mcabber/doc/mcabber.1.html	Sat Oct 08 00:29:02 2005 +0200
+++ b/mcabber/doc/mcabber.1.html	Sat Oct 08 00:29:37 2005 +0200
@@ -201,7 +201,7 @@
 /add jid [nickname]
 </b></dt>
 <dd>
-        Add the <b>jid</b> Jabber user to our roster (default group), and send a
+        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.
 </dd>
@@ -264,7 +264,7 @@
 <b>search_backward</b> text
 </td>
 <td>
-search for text in the current buddy chat buffer
+search for "text" in the current buddy chat buffer
 </td>
 </tr>
 <tr valign="top">
@@ -272,7 +272,7 @@
 <b>search_forward</b>  text
 </td>
 <td>
-search for text in the current buddy chat buffer
+search for "text" in the current buddy chat buffer
 </td>
 </tr>
 <tr valign="top">
@@ -438,7 +438,7 @@
         the buddies to another group with the "/move" command).
 </dd>
 <dt><b>
-/room invite|join|leave|names|nick|remove|topic|unlock
+/room invite|join|leave|names|nick|privmsg|remove|topic|unlock
 </b></dt>
 <dd>
         The <b>room</b> command handles Multi-User Chat room actions.
@@ -485,6 +485,14 @@
 </tr>
 <tr valign="top">
 <td>
+<b>privmsg</b> nick msg
+</td>
+<td>
+send private message "msg" to "nick"
+</td>
+</tr>
+<tr valign="top">
+<td>
 <b>remove</b>
 </td>
 <td>
@@ -615,14 +623,14 @@
 /say text
 </b></dt>
 <dd>
-        Send the text message to the currently selected buddy.  Can be useful
+        Send the "text" message to the currently selected buddy.  Can be useful
         if you want to send a message beginning with a slash, for example.
 </dd>
 <dt><b>
 /say_to jid text
 </b></dt>
 <dd>
-        Send the text message to the specified jid.
+        Send the "text" message to the specified jid.
         Please note that this command doesn't set the default resource for
         a contact, so if you want to send several messages to a specific
         ressource you will have to use "/say_to" for each message.
@@ -670,7 +678,7 @@
 <div id="footer">
 <p>
 Version 0.6.9-dev<br />
-Last updated 07-Oct-2005 18:59:10 CEST
+Last updated 08-Oct-2005 00:26:22 CEST
 </p>
 </div>
 </div>
--- a/mcabber/doc/mcabber.1.txt	Sat Oct 08 00:29:02 2005 +0200
+++ b/mcabber/doc/mcabber.1.txt	Sat Oct 08 00:29:37 2005 +0200
@@ -83,7 +83,7 @@
 --------
 
 /add jid [nickname]::
-        Add the 'jid' Jabber user to our roster (default group), and send a
+        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.
 
@@ -111,8 +111,8 @@
         'clear';;                clear the current buddy chat window
         'top';;                  jump to the top of the current buddy chat buffer
         'bottom';;               jump to the bottom of the current buddy chat buffer
-        'search_backward' text;; search for text in the current buddy chat buffer
-        'search_forward'  text;; search for text in the current buddy chat buffer
+        'search_backward' text;; search for "text" in the current buddy chat buffer
+        'search_forward'  text;; search for "text" in the current buddy chat buffer
         'date' date;;            jump to the first line after the specified date in the chat buffer (date format: "YYYY-mm-dd[THH:MM:SS]", "-" and ":" are optional)
         '%' n;;                  jump to position %n of the buddy chat buffer
 
@@ -176,7 +176,7 @@
         This command does not work for groups, at the moment (but you can move
         the buddies to another group with the "/move" command).
 
-/room invite|join|leave|names|nick|remove|topic|unlock::
+/room invite|join|leave|names|nick|privmsg|remove|topic|unlock::
         The 'room' command handles Multi-User Chat room actions.
 
         'invite' jid [reason];; invite jid to the current room
@@ -184,6 +184,7 @@
         'leave' [message];;     leave the current room
         'names';;               display members of the current room
         'nick' nick;;           change your nickname in the current room
+        'privmsg' nick msg;;    send private message "msg" to "nick"
         'remove';;              remove the current room from the roster (you must have left this room before)
         'topic';;               set topic for current room
         'unlock';;              unlock current room (if you are the owner)
@@ -206,11 +207,11 @@
         'unread_next';;  jump to the next unread message
 
 /say text::
-        Send the text message to the currently selected buddy.  Can be useful
+        Send the "text" message to the currently selected buddy.  Can be useful
         if you want to send a message beginning with a slash, for example.
 
 /say_to jid text::
-        Send the text message to the specified jid.
+        Send the "text" message to the specified jid.
         Please note that this command doesn't set the default resource for
         a contact, so if you want to send several messages to a specific
         ressource you will have to use "/say_to" for each message.