mcabber/doc/mcabber.1.txt
changeset 2304 fa8365fb6ac2
parent 2302 245ec6d73380
child 2314 0d5660c6b4aa
equal deleted inserted replaced
2303:4f3821bda633 2304:fa8365fb6ac2
    61 "main status line" and reflects mcabber general status.  The other line
    61 "main status line" and reflects mcabber general status.  The other line
    62 is the "chat status line" and shows the status of the currently selected
    62 is the "chat status line" and shows the status of the currently selected
    63 buddy.
    63 buddy.
    64 
    64 
    65 To display buddies chat buffers, you will have to enter 'chat mode'.
    65 To display buddies chat buffers, you will have to enter 'chat mode'.
    66 You can enter chat mode by pressing enter, and leave chat mode with the ESC
    66 You can enter chat mode by pressing enter (unless 'vi mode' is enabled), and
    67 key.  Simply sending a message will also enable chat mode.
    67 leave chat mode with the ESC key.  Simply sending a message will also enable
       
    68 chat mode (unless 'vi mode' is enabled).
    68 
    69 
    69 There are several advantages to the two-mode implementation: first, it allows
    70 There are several advantages to the two-mode implementation: first, it allows
    70 accurate "unread" message functionality, as described in the next section;
    71 accurate "unread" message functionality, as described in the next section;
    71 without this, merely scrolling to a specific buddy will "read" the new
    72 without this, merely scrolling to a specific buddy will "read" the new
    72 messages of all buddies in-between.  Second, it allows quickly hiding the
    73 messages of all buddies in-between.  Second, it allows quickly hiding the
   112 Ctrl-t::        Transpose chars
   113 Ctrl-t::        Transpose chars
   113 Ctrl-o::        Accept line and put the next history line in the input line (accept-line-and-down-history)
   114 Ctrl-o::        Accept line and put the next history line in the input line (accept-line-and-down-history)
   114 
   115 
   115 Additional key bindings may be specified using the '/bind' command described
   116 Additional key bindings may be specified using the '/bind' command described
   116 in the COMMANDS section.
   117 in the COMMANDS section.
       
   118 
       
   119 VI MODE
       
   120 -------
       
   121 If the 'vi_mode' option is set to 1, `mcabber(1)` accepts a few commands
       
   122 loosely based on those available in `vi(1)`'s normal mode.  In this case, chat
       
   123 mode is not entered by pressing enter, and messages cannot be composed outside
       
   124 of the chat mode.  The following commands are accepted:
       
   125 
       
   126 A::             Call "/roster unread_first".
       
   127 a::             Call "/roster unread_next".
       
   128 F::             Call "/roster group_prev".
       
   129 f::             Call "/roster group_next".
       
   130 G::             Call "/roster bottom".
       
   131 gg::            Call "/roster top".
       
   132 i::             Enter chat mode.
       
   133 ['n']j::        Call "/roster down ['n']".
       
   134 ['n']k::        Call "/roster up ['n']".
       
   135 n::             Repeat the previous search (if any).
       
   136 O::             Call "/roster unread_first" and open chat window.
       
   137 o::             Call "/roster unread_next" and open chat window.
       
   138 ZZ::            Call "/quit".
       
   139 zM::            Call "/group fold" for all groups.
       
   140 zR::            Call "/group unfold" for all groups.
       
   141 \''::           Call "/roster alternate".
       
   142 !::             Toggle attention flag for current buddy.
       
   143 #::             Toggle unread messages flag for current buddy.
       
   144 <Space>::       Call "/group toggle" for the current group.
       
   145 
       
   146 A leading slash enables search mode:
       
   147 
       
   148 /'string'::     Call "/roster search 'string'".
       
   149 
       
   150 A leading colon enabled command-line mode:
       
   151 
       
   152 :q::            Call "/quit".
       
   153 :'n'::          Jump to line 'n' in the roster.
       
   154 :'cmd-line'::   Call "/'cmd-line'" (unless the 'cmd-line' matches one of the
       
   155                 above commands).
       
   156 
       
   157 Commands entered with a leading colon and searches are either submitted by
       
   158 pressing enter or aborted by hitting escape.  In either case, `mcabber(1)`
       
   159 returns to the normal (non-chat) mode.  History editing is supported in
       
   160 command-line mode and in search mode.  In command-line mode, tab completion is
       
   161 supported as well.
   117 
   162 
   118 MCABBER'S ROSTER
   163 MCABBER'S ROSTER
   119 ----------------
   164 ----------------
   120 The first listed item on the roster is '[status]', which keeps a log of
   165 The first listed item on the roster is '[status]', which keeps a log of
   121 everything that appears in the short log window below the main chat area.
   166 everything that appears in the short log window below the main chat area.