view mcabber/doc/mcabber.1.txt @ 200:f042a2400809

[/trunk] Changeset 212 by mikael * Update documentation.
author mikael
date Sat, 07 May 2005 12:26:32 +0000
parents e574c859190a
children 9bdc6d9996f6
line wrap: on
line source

MCABBER(1)
===========
Mikael BERTHE <bmikael@lists.lilotux.net>
May 2005

NAME
----
mcabber - a simple Jabber console client

SYNOPSIS
--------
'mcabber' [ -f configfile ] [ --help | -h ]

DESCRIPTION
-----------
'mcabber'(1) is a small Jabber console client.
For now it needs a configuration file to start, so please copy the sample
mcabberrc file and update your connection options.

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,
under a small 'log window'.

Commands completion.  If possible, mcabber(1) will try to complete your
commands line if you hit the Tab key.

Chat mode.  When 'chat mode' is enabled, the buddies chat buffers are
displayed.  Otherwise, the chat window is empty.  You can enter chat mode by
pressing enter, and leave chat mode with the ESC key.  Sending a message also
enables chat mode implicitly.

History logging.  If enabled (see the CONFIGURATION FILE section), mcabber(1)
can save discussions to history log files.

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).

OPTIONS
-------
--help, -h::
	Quick help usage message

-f configfile::
	Use configuration file 'configfile'

KEYS
----

Text typing happens in the 'input line'; 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.

To send a message, move to the choosen 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 key bindings:

Ctrl-a::        Go to the beginning of the input line
Ctrl-e::        Go to the end of the input line
Ctrl-l::        Force a resize
PgUp/PgDown::   Move inside the roster (buddylist)
Tab::           Complete current word, in the input line
Ctrl-g::        Cancel completion / ctrl-g
Ctrl-p/Ctrl-n:: Scroll up/down half a screen in the buffer window (chat mode)
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-q::        Jump to the next unread message (Not yet implemented)

COMMANDS
--------

/add jid::
        Add the 'jid' Jabber user to our roster, and send a notification
        request to this buddy

/buffer clear|top|bottom::
	The 'buffer' command manipulates the current buddy's buffer
	(chat window).

	clear:  clear the current buddy chat window

	top:    jump to the top of the current buddy chat buffer

	bottom: jump to the bottom of the current buddy chat buffer

/clear::
	The 'clear' command is an alias for "/buffer clear".

/group expand|shrink|toggle::
	The 'group' command changes the group display settings.

	expand: expand (unfold) the current group tree in the roster

	shrink: shrink (fold) the current group tree in the roster

	toggle: toggle the fold/unfold state of the current tree

        Note: the "fold" and "unfold" keywords are accepted.

/info::
	Display info on the selected entry (user, agent, group...)

/quit::
	Disconnect and leave mcabber(1)

/roster hide_offline|show_offline|top|bottom::
	The 'roster' command manipulates the roster/buddylist.

	hide_offline: hide offline buddies

        show_offline: show offline buddies

        top:          jump to the top of the roster

        bottom:	      jump to the bottom of the roster

/say text::
	Send the text message to the currently selected buddy.  Can be useful
        if you want to send a message beginning with a slash, for example.

/status [online|avail|invisible|free|dnd|busy|notavail|away]::
        Set the current status.  If no status is specified, display the
        current status.

CONFIGURATION FILE
------------------
See the provided sample configuration file, which should be self-documented.

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

    $HOME/.mcabber/mcabberrc    Default configuration file
    $HOME/.mcabberrc            Configuration file used if no other has been found
    $HOME/.mcabber/histo/       Default directory for storing chat history files, if enabled

BUGS
----
Certainly a lot.

AUTHOR
------
Written by Mikael BERTHE, <bmikael@lists.ilotux.net>.  
Originally based on cabber (see <http://cabber.sourceforge.net>), please
consult the AUTHORS file for details.

RESOURCES
---------
Main web site: http://www.lilotux.net/~mikael/mcabber/

COPYING
-------
Copyright (C) 2005 Mikael Berthe.
Some portions are Copyright (C) 2002-2004 <cabber@ajmacias.com>.

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