logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

mcabber - a simple Jabber (XMPP) console client

Author

MikaelBERTHE <mcabber@lilotux.net>
           Author.

Bugs

       Certainly. Please tell me if you find one! :-) Please visit our website to find out about the MUC room
       and the bug tracker.

Commands

       Please refer to the online help (command /help), it is probably more up-to-date than this manpage.
       Furthermore, help files have been translated into several languages. You will find an overview of the
       mcabber commands in this manual.

Configuration File

       See the provided sample configuration file, which should be self-documenting.

Copying

       Copyright (C) 2005-2020 Mikael Berthe and others.

       Free use of this software is granted under the terms of the GNU General Public License (GPL).

Description

mcabber(1) is a small Jabber (XMPP) console client. For now it needs a configuration file to start, so
       please copy the sample mcabberrc file and adapt your connection settings.

       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:

       •   SASL/SSL/TLSsupport.

       •   MUCsupport (Multi-User Chat).

       •   PGP,OTRsupportChatStates support (typing notifications)

       •   Historylogging: If enabled (see the CONFIGURATION FILE section), mcabber can save discussions to
           text history log files.

       •   Commandscompletion: If possible, mcabber will try to complete your command line if you hit the Tab
           key.

       •   Inputlinehistory: Any message or command entered is in the input line history and can be reused
           easily.

       •   Externalactions: 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.

       •   Modules:mcabber can load modules (a.k.a. plugins) at runtime that extend its features.

Files

       The following files can be used by mcabber(1):

           $HOME/.mcabber/mcabberrc    Default configuration file
           $HOME/.config/mcabber/mcabberrc Alternate location (can use XDG_CONFIG_HOME)
           $HOME/.mcabberrc            Configuration file used if no other has been found
           $HOME/.mcabber/histo/       Default directory for storing chat history files, if enabled
           /usr/share/mcabber/help/    Default directory for online help files
           /usr/lib/mcabber/           Default directory for modules

Keys

       Text typing occurs in the inputline; basic operations are supported (left arrow, right arrow, home/end
       keys, insert, delete, backspace...).

       PageUp and PageDown keys are used to move in the roster.

       Up and Down arrow keys can be used to move in the input line history; they jump to the previous/next line
       from the history beginning with the same string (from first column to the cursor column).

       To send a message, move to the chosen buddy in the buddylist, type your message and hit enter. If the
       line begins with a slash, this will be interpreted as a command (see the COMMAND section below). Hit
       escape to leave the chat mode.

       Here is a quick description of the default 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

       Up/Down
           Move in the input line history

       PgUp/PgDown
           Move inside the roster (buddylist)

       Tab
           Complete current word, in the input line

       Ctrl-g
           Cancel completion

       Ctrl-c
           Abort multi-line messages and completions

       Ctrl-d
           Send/terminate a multi-line message

       Ctrl-p/Ctrl-n
           Scroll up/down half a screen in the buffer window (chat mode)

       Ctrl-Left
           Move the cursor back to the start of the current or previous word

       Ctrl-Right
           Move the cursor forward to the end of the current or next word

       Ctrl-u
           Delete from beginning of the line to the cursor

       Ctrl-k
           Delete from the cursor to the end of line

       Ctrl-w
           Backward kill word

       Ctrl-t
           Transpose chars

       Ctrl-o
           Accept line and put the next history line in the input line (accept-line-and-down-history)

       Additional key bindings may be specified using the /bind command described in the COMMANDS section.

Mcabber’S Roster

       The first listed item 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 items that are within them, and are indicated by --- to the left of
       the name.

       For every real Jabber contact, the roster displays four pieces of information: the buddy’s name or alias,
       its online status, its authorization status, and whether there are unread messages from the buddy waiting
       for you.

       The online status is one of the following:

       o
           online

       f
           free for chat

       a
           away

       n
           not available (labeled extendedaway in some clients)

       d
           do not disturb

       _
           offline (or invisible to you)

       ?
           unknown, usually meaning you are not authorized to see this buddy’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 buddy is authorized to receive your online status updates,
       and is displayed by the brackets surrounding the buddy’s online status. Square brackets, like [o],
       indicate that this buddy 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 a buddy which you have not looked at, a hash mark (#) appears in the
       leftmost section of the roster for that buddy. The hash mark disappears once you view that buddy’s
       message buffer. When the user attention is requested (or when you receive a message containing your
       nickname in a MUC room), the hash mark is replaced with the attentionsign, an exclamation mark (!).

       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

Name

       mcabber - a simple Jabber (XMPP) console client

Notes

        1. Mikael BERTHE
           mailto:mikael@lilotux.net

        2. Main web site
           http://mcabber.com/

        3. Official wiki
           http://wiki.mcabber.com/

        4. MCabber MUC room
           xmpp:mcabber@conf.lilotux.net

  1.1.2                                          September 2020                                       MCABBER(1)

Options

       -h
           Quick help usage message

       -V
           Displays mcabber version and compile-time definitions.

       -f configfile
           Use configuration file configfile

Resources

Mainwebsite[2]

       Officialwiki[3]

       MCabberMUCroom[4]

Synopsis

mcabber [ -h | -V | -f configfile ]

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:

           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.

Windows/Panes

       The mcabber(1) screen is divided into 4 regions. The roster, alias buddylist, is on the left. The chatwindow, or chat buffer, is on the right. The inputline lies at the bottom of the screen, under a small
       logwindow.

       Two status lines surround the log window. The bottom status line is the "main status line" and reflects
       mcabber general status. The other line is the "chat status line" and shows the status of the currently
       selected buddy.

       To display buddies chat buffers, you will have to enter chatmode. You can enter chat mode by pressing
       enter (unless vimode is enabled), and leave chat mode with the ESC key. Simply sending a message will
       also enable chat mode (unless vimode is enabled).

       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 /rosteralternate command described in another section, without having to manually scroll back and
       forth.

See Also