diff mcabber/doc/mcabber.1.txt @ 2304:fa8365fb6ac2

[PATCH 1/3] New option: vi_mode If the new vi_mode option is set to 1, let MCabber's non-chat mode accept a few commands loosely based on those available in vi(1)'s normal mode, e.g.: A Call "/roster unread_first". a Call "/roster unread_next". F Call "/roster group_prev". f Call "/roster group_next". G Call "/roster bottom". gg Call "/roster top". i Enter chat mode. [<n>]j Call "/roster down [<n>]". [<n>]k Call "/roster up [<n>]". n Repeat the previous search (if any). O Call "/roster unread_first" and open chat window. o Call "/roster unread_next" and open chat window. ZZ Call "/quit". zM Call "/group fold" for all groups. zR Call "/group unfold" for all groups. <Space> Call "/group toggle" for the current group. '' Call "/roster alternate". ! Toggle attention flag for current buddy. # Toggle unread messages flag for current buddy. /<str> Call "/roster search <str>". :q Call "/quit". :wq Call "/quit". :x Call "/quit". :<n> Jump to line <n> in the roster. :<cmd> Call "/<cmd>" (unless <cmd> matches one of the above commands).
author Holger Weiß <holger@zedat.fu-berlin.de>
date Wed, 22 Jul 2015 19:25:22 +0200
parents 245ec6d73380
children 0d5660c6b4aa
line wrap: on
line diff
--- a/mcabber/doc/mcabber.1.txt	Mon Jan 30 18:46:15 2017 +0100
+++ b/mcabber/doc/mcabber.1.txt	Wed Jul 22 19:25:22 2015 +0200
@@ -63,8 +63,9 @@
 buddy.
 
 To display buddies chat buffers, you will have to enter 'chat mode'.
-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.
+You can enter chat mode by pressing enter (unless 'vi mode' is enabled), and
+leave chat mode with the ESC key.  Simply sending a message will also enable
+chat mode (unless 'vi mode' is enabled).
 
 There are several advantages to the two-mode implementation: first, it allows
 accurate "unread" message functionality, as described in the next section;
@@ -115,6 +116,50 @@
 Additional key bindings may be specified using the '/bind' command described
 in the COMMANDS section.
 
+VI MODE
+-------
+If the 'vi_mode' option is set to 1, `mcabber(1)` accepts a few commands
+loosely based on those available in `vi(1)`'s normal mode.  In this case, chat
+mode is not entered by pressing enter, and messages cannot be composed outside
+of the chat mode.  The following commands are accepted:
+
+A::             Call "/roster unread_first".
+a::             Call "/roster unread_next".
+F::             Call "/roster group_prev".
+f::             Call "/roster group_next".
+G::             Call "/roster bottom".
+gg::            Call "/roster top".
+i::             Enter chat mode.
+['n']j::        Call "/roster down ['n']".
+['n']k::        Call "/roster up ['n']".
+n::             Repeat the previous search (if any).
+O::             Call "/roster unread_first" and open chat window.
+o::             Call "/roster unread_next" and open chat window.
+ZZ::            Call "/quit".
+zM::            Call "/group fold" for all groups.
+zR::            Call "/group unfold" for all groups.
+\''::           Call "/roster alternate".
+!::             Toggle attention flag for current buddy.
+#::             Toggle unread messages flag for current buddy.
+<Space>::       Call "/group toggle" for the current group.
+
+A leading slash enables search mode:
+
+/'string'::     Call "/roster search 'string'".
+
+A leading colon enabled command-line mode:
+
+:q::            Call "/quit".
+:'n'::          Jump to line 'n' in the roster.
+:'cmd-line'::   Call "/'cmd-line'" (unless the 'cmd-line' matches one of the
+                above commands).
+
+Commands entered with a leading colon and searches are either submitted by
+pressing enter or aborted by hitting escape.  In either case, `mcabber(1)`
+returns to the normal (non-chat) mode.  History editing is supported in
+command-line mode and in search mode.  In command-line mode, tab completion is
+supported as well.
+
 MCABBER'S ROSTER
 ----------------
 The first listed item on the roster is '[status]', which keeps a log of