diff mcabber/doc/mcabber.1.txt @ 854:bfaab692a683

Update manpage (pmw) This is Philip M. White's manpage update patch, slightly modified.
author Mikael Berthe <mikael@lilotux.net>
date Sat, 13 May 2006 22:26:15 +0200
parents f8c0447beec2
children 4b77a2ab18e5
line wrap: on
line diff
--- a/mcabber/doc/mcabber.1.txt	Sat May 13 22:21:20 2006 +0200
+++ b/mcabber/doc/mcabber.1.txt	Sat May 13 22:26:15 2006 +0200
@@ -20,6 +20,31 @@
 You also need to have an existing Jabber account to use this software, as
 it cannot (un)register accounts yet.
 
+Here are some of the features of `mcabber`:
+
+- 'SSL support'.
+- 'MUC support' (Multi-User Chat).
+- '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
+  command line if you hit the Tab key.
+- 'Input line history:'  Any message or command entered is in the input line
+  history and can be reused easily.
+- 'External actions:'  Some events (like receiving a message) can trigger an
+  external action such as a shell script if you enable it in your
+  configuration file.  A sample events script ("eventcmd") is provided with
+  `mcabber` source code, in the contrib directory.
+
+OPTIONS
+-------
+--help, -h::
+        Quick help usage message
+
+-f configfile::
+        Use configuration file 'configfile'
+
+WINDOWS/PANES
+-------------
 The `mcabber(1)` screen is divided into 4 regions.
 The 'roster', alias 'buddylist', is on the left.  The 'chat window', or chat
 buffer, is on the right.  The 'input line' lies at the bottom of the screen,
@@ -34,32 +59,17 @@
 You can enter chat mode by pressing enter, and leave chat mode with the ESC
 key.  Simply sending a message will also enable chat mode.
 
-Here are some of the features of `mcabber`:
-
-- 'SSL support'.
-- 'MUC support' (Multi-User Chat).
-- '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
-  command line if you hit the Tab key.
-- 'Input line history:'  Any message or command entered is in the input line
-  history and can be reused easily.
-- 'External actions:'  Some events (like receiving a message) can trigger an
-  external action, for example a shell script (you need to enable it in your
-  configuration file).  A sample events script ("eventcmd") is provided with
-  `mcabber` source code, in the contrib directory.
-
-OPTIONS
--------
---help, -h::
-        Quick help usage message
-
--f configfile::
-        Use configuration file 'configfile'
+There are several advantages to the two-mode implementation: first, it allows
+accurate "unread" message functionality, as described in the next section;
+without this, merely scrolling to a specific buddy will "read" the new
+messages of all buddies in-between.  Second, it allows quickly hiding the
+conversation with a single keystroke.  Third, it allows jumping between
+the few buddies with whom you are conversing with the '/roster alternate'
+command described in another section, without having to manually scroll
+back and forth.
 
 KEYS
 ----
-
 Text typing occurs in the 'input line'; basic operations are supported
 (left arrow, right arrow, home/end keys, insert, delete, backspace...).
 
@@ -93,15 +103,57 @@
 Ctrl-o::        Accept line and put the next history line in the input line (accept-line-and-down-history)
 Ctrl-q::        Jump to the next unread message
 
-COMMANDS
---------
+Additional key bindings may be specified using the /bind command described
+in the COMMANDS section.
+
+MCABBER'S ROSTER
+----------------
+The first listed resource on the roster is '[status]', which keeps a log of
+everything that appears in the short log window below the main chat area.
+While the log window was designed for showing the latest few elements, the
+dedicated '[status]' buffer allows more comfortable viewing of the log, as
+well as scrolling it in a standard manner.
+
+Group names are displayed above the resources that are within them, and are
+indicated by '---' to the left of the name.
+
+For every real Jabber resource, the roster displays four pieces of information:
+the resource's name or alias, its online status, its authorization status, and
+whether there are unread messages from the resource waiting for you.
+
+The online status is one of the following:
 
-/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 (or an empty string "") is provided or if jid
-        is ".", the current buddy is used.
+        'o';;  online
+        'f';;  free for chat
+        'a';;  away
+        'n';;  not available (labeled 'extended away' in some clients)
+        'd';;  do not disturb
+        'i';;  invisible (displayed only for your resource)
+        '_';;  offline (or invisible to you)
+        '?';;  unknown, usually meaning you are not authorized to see this resource's status
+        'x';;  a conference room in which you are not participating
+        'C';;  a conference room in which you are participating
 
+The authorization status indicates whether a resource is authorized to receive
+your online status updates, and is displayed by the brackets surrounding the
+resource's online status.  Square brackets, like '[o]', indicate that this
+resource is authorized to receive your status.  Curly braces, like '\{o\}',
+indicate that they are not authorized to receive your status.
+
+When there are unread messages from the resource which you have not looked at,
+a hash mark ('#') appears in the leftmost section of the roster for that
+resource.  The hash mark disappears once you view that resource's message log.
+
+Examples:
+
+        ' --- Buds';;     This is a group named 'Buds'
+        '#[o] John';;     John is online, can see your status, and sent you a message that you did not read yet
+        ' \{?\} Sally';;  Neither you nor Sally have authorized each other to see your online status
+        ' \{a\} Jane';;   Jane is away, but she cannot see your online status
+        '#[C] x@y.c';;    You are participating in x@y.c conference room, and there are unread messages
+
+COMMANDS RELATED TO MCABBER
+---------------------------
 /alias name = command line::
         Add "name" as an alias for "command line". +
         Aliases are expanded only once, thus they can not be chained. +
@@ -109,15 +161,6 @@
         "/alias name =" unsets the "name" alias. +
         Example: "/alias away = status away".
 
-/authorization allow|cancel|request|request_unsubscribe [jid]::
-        Manage the presence subscriptions. +
-        If no jid is provided, the current buddy is used.
-
-        'allow';;   allow the buddy to receive your presence updates
-        'cancel';;  cancel the buddy' subscription to your presence updates
-        'request';; request a subscription to the buddy's presence updates
-        'request_unsubscribe';; request unsubscription from the buddy's presence updates
-
 /bind 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
@@ -145,13 +188,17 @@
 /clear::
         The 'clear' command is actually an alias for "/buffer clear".
 
+/quit::
+        Disconnect and leave `mcabber(1)`.
+
+/version::
+        Display mcabber version
+
+COMMANDS RELATED TO THE SERVER AND CONNECTION
+---------------------------------------------
 /connect::
         Establish connection to the Jabber server.
 
-/del::
-        Delete the current buddy from our roster, unsubscribe from its presence
-        notification and unsubscribe it from ours.
-
 /disconnect::
         Terminate connection to the Jabber server.  Note: the roster is only
         available when the connection to the server is active, so the
@@ -168,6 +215,30 @@
         'reject';;  reject the event #n
         'list';;    list all pending events
 
+/rawxml send::
+        'send' string: send string (raw XML format) to the Jabber server.  No check is done on the string provided.  BEWARE! Use this only if you know what you are doing, or you could terminate the connection.
+
+COMMANDS RELATED TO THE ROSTER AND JABBER RESOURCES
+---------------------------------------------------
+/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 (or an empty string "") is provided or if jid
+        is ".", the current buddy is used.
+
+/authorization allow|cancel|request|request_unsubscribe [jid]::
+        Manage the presence subscriptions. +
+        If no jid is provided, the current buddy is used.
+
+        'allow';;   allow the buddy to receive your presence updates
+        'cancel';;  cancel the buddy' subscription to your presence updates
+        'request';; request a subscription to the buddy's presence updates
+        'request_unsubscribe';; request unsubscription from the buddy's presence updates
+
+/del::
+        Delete the current buddy from our roster, unsubscribe from its presence
+        notification and unsubscribe it from ours.
+
 /group fold|unfold|toggle::
         The 'group' command changes the current group display.
 
@@ -211,12 +282,6 @@
         'toggle_verbatim';; same with verbatim multi-line mode
         'abort';;           leave multi-line mode without sending the message
 
-/quit::
-        Disconnect and leave `mcabber(1)`.
-
-/rawxml send::
-        'send' string: send string (raw XML format) to the Jabber server.  No check is done on the string provided.  BEWARE! Use this only if you know what you are doing, or you could terminate the connection.
-
 /rename nickname::
         Rename current buddy to the given nickname.
         This command does not work for groups, at the moment (but you can move
@@ -295,12 +360,9 @@
         too. +
         Note: The jid can include a resource (i.e. user@server/resource).
 
-/version::
-        Display mcabber version
-
 CONFIGURATION FILE
 ------------------
-See the provided sample configuration file, which should be self-documented.
+See the provided sample configuration file, which should be self-documenting.
 
 FILES
 -----