changeset 1062:9207f2efb921

Update documentation - /request last - /request vcard - /room bookmark - /roster note ... and a few minor manpage updates.
author Mikael Berthe <mikael@lilotux.net>
date Thu, 30 Nov 2006 23:50:41 +0100
parents da696ed4acf4
children 4e62941df777
files mcabber/doc/help/en/hlp_request.txt mcabber/doc/help/en/hlp_room.txt mcabber/doc/help/en/hlp_roster.txt mcabber/doc/mcabber.1.txt
diffstat 4 files changed, 22 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/mcabber/doc/help/en/hlp_request.txt	Thu Nov 30 22:00:39 2006 +0100
+++ b/mcabber/doc/help/en/hlp_request.txt	Thu Nov 30 23:50:41 2006 +0100
@@ -1,9 +1,13 @@
 
- /REQUEST time|version [jid]
+ /REQUEST last|time|vcard|version [jid]
 
 Send a "IQ" query to the current buddy, or to the specified Jabber user.  If the resource is not provided with the jid, mcabber will send the query to all known resources for this user.
 
+/request last
+ Request "last" information (usually idle time)
 /request time
  Request time from the buddy
+/request vcard
+ Request VCard from the buddy
 /request version
  Request version from the buddy
--- a/mcabber/doc/help/en/hlp_room.txt	Thu Nov 30 22:00:39 2006 +0100
+++ b/mcabber/doc/help/en/hlp_room.txt	Thu Nov 30 23:50:41 2006 +0100
@@ -1,6 +1,7 @@
 
  /ROOM join|leave|names|nick|remove|topic|unlock|destroy
  /ROOM privmsg|invite|kick|ban|role|affil
+ /ROOM bookmark [add|del] [-autojoin|+autojoin]
 
 The 'room' command handles Multi-User Chat room actions.
 
@@ -34,3 +35,6 @@
  Change jid's role (role can be "none", "visitor", "participant", "moderator")
 /room affil jid affil [reason]
  Change jid's affiliation (affil can be "none", "member", "admin", "owner")
+/room bookmark [add|del] [-autojoin|+autojoin]
+ Add, remove or update a bookmark (default is add).
+ If autojoin is set, mcabber will automatically join the MUC room when it connects to the server.
--- a/mcabber/doc/help/en/hlp_roster.txt	Thu Nov 30 22:00:39 2006 +0100
+++ b/mcabber/doc/help/en/hlp_roster.txt	Thu Nov 30 23:50:41 2006 +0100
@@ -3,6 +3,7 @@
  /ROSTER hide|show|toggle
  /ROSTER alternate|unread_first|unread_next
  /ROSTER search bud
+ /ROSTER note [-|text]
 
 The 'roster' command manipulates the roster/buddylist.
 Here are the available parameters:
@@ -39,3 +40,7 @@
  Jump to the first unread message
 /roster unread_next
  Jump to the next unread message
+/roster note [-|text]
+ Set/update/delete an annotation.
+ If there is no text, the current item's annotation is displayed -- if you are in the status buffer, all notes are displayed.
+ If text is "-", the note is erased.
--- a/mcabber/doc/mcabber.1.txt	Thu Nov 30 22:00:39 2006 +0100
+++ b/mcabber/doc/mcabber.1.txt	Thu Nov 30 23:50:41 2006 +0100
@@ -24,6 +24,8 @@
 
 - 'SSL support'.
 - 'MUC support' (Multi-User Chat).
+- 'PGP support'
+- 'Chat States' support (typing notifications)
 - 'History logging:'  If enabled (see the CONFIGURATION FILE section),
   `mcabber` can save discussions to history log files.
 - 'Commands completion:'  If possible, `mcabber` will try to complete your
@@ -86,6 +88,7 @@
 
 Here is a quick description of the key bindings:
 
+Esc::           Disable chat mode
 Ctrl-a::        Go to the beginning of the input line
 Ctrl-e::        Go to the end of the input line
 Ctrl-l::        Force a refresh
@@ -298,13 +301,14 @@
         Please note that a group name change is only done when the server's
         acknowledgment is received, so a slight delay can be noticed.
 
-/request time|version [jid]::
+/request last|time|vcard|version [jid]::
         Send a "IQ" query to the current buddy, or to the specified Jabber
         user.  If the resource is not provided with the jid, mcabber will
         send the query to all known resources for this user.
 
 /room join|leave|names|nick|privmsg|remove|topic|unlock|destroy::
 /room invite|kick|ban|role|affil::
+/room bookmark [add|del] [-autojoin|+autojoin]::
         The 'room' command handles Multi-User Chat room actions.
 
         'join' [room [nick [pass]]];; join "room", using "nick" as nickname.  If no nickname is provided (or if it is an empty string), the "nickname" option value is used (see sample configuration file).  If the currently selected entry is correctly recognized as a room by mcabber, the shortcut "." can be used instead of the full room id.  A password can be provided to enter protected rooms.  If your nickname contains space characters, use quotes.
@@ -322,11 +326,13 @@
         '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")
+        'bookmark'              add/update/remove a room bookmark, set/unset autojoin
 
 /roster bottom|top|hide_offline|show_offline|toggle_offline::
 /roster hide|show|toggle::
 /roster alternate|unread_first|unread_next::
 /roster search bud::
+/roster note [-|text]::
         The 'roster' command manipulates the roster/buddylist.  Here are the available parameters:
 
         'bottom';;       jump to the bottom of the roster
@@ -345,6 +351,7 @@
         'alternate';;    jump to alternate buddy.  The "alternate" buddy is the last buddy left while being in chat mode (this command is thus especially useful after commands like "/roster unread_first")
         'unread_first';; jump to the first unread message
         'unread_next';;  jump to the next unread message
+        'note' [text];;  display or set an annotation (if text is "-", the annotation is deleted).  In the "status" buffer, it will display all annotations.
 
 /say text::
         Send the "text" message to the currently selected buddy.  Can be useful