view mcabber/doc/mcabber.1 @ 232:9a6ba4b38e63

[/trunk] Changeset 245 by mikael * Fix backspace handling (KEY_BACKSPACE isn't reliable) * UTF-8 locale detection * Display a warning when the locale is UTF-8 * Display log notice when sending a notification request message * Update TODO * Update INSTALL and mcabberrc.example files for better explanations
author mikael
date Wed, 08 Jun 2005 18:33:28 +0000
parents bfc14cfb068e
children 72fd1273f2b7
line wrap: on
line source

.\"Generated by db2man.xsl. Don't modify this, modify the source.
.de Sh \" Subsection
.if t .Sp
.ne 5
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
.de Ip \" List item
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
.TH "MCABBER" 1 "" "" ""
mcabber \- a simple Jabber console client

mcabber [ \-f configfile ] [ --help | \-h ]


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 adapt your connection settings\&.

The mcabber(1) screen is divided into 4 regions\&. The \fIroster\fR, alias \fIbuddylist\fR, is on the left\&. The \fIchat window\fR, or chat buffer, is on the right\&. The \fIinput line\fR lies at the bottom of the screen, under a small \fIlog window\fR\&.

To display buddies chat buffers, you will have to enter \fIchat mode\fR\&. 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:

.TP 3
 SSL support\&.
 History logging: If enabled (see the CONFIGURATION FILE section), mcabber(1) can save discussions to history log files\&.
 Commands completion: If possible, mcabber(1) will try to complete your command line if you hit the Tab key\&.
 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)\&.


--help, \-h
Quick help usage message

\-f configfile
Use configuration file configfile 


Text typing occurs in the \fIinput line\fR; 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)


\fB/add\fR jid
Add the jid Jabber user to our roster, and send a notification request to this buddy\&.

\fB/buffer\fR clear|top|bottom
The buffer command manipulates the current buddy's buffer (chat window)\&.

 \fBclear\fR	clear the current buddy chat window
 \fBtop\fR	jump to the top of the current buddy chat buffer
 \fBbottom\fR	jump to the bottom of the current buddy chat buffer

The clear command is actually an alias for "/buffer clear"\&.

Delete the current buddy from our roster, unsubscribe from its presence notification and unsubscribe it from ours\&.

\fB/group\fR expand|shrink|toggle
The group command changes the group display settings\&.

 \fBexpand\fR expand the current group tree in the roster (syn: unfold)
 \fBshrink\fR shrink the current group tree in the roster (syn: fold)
 \fBtoggle\fR toggle the fold/unfold state of the current tree

Display info on the selected entry (user, agent, group...)\&.

\fB/move\fR [groupname]
Move the current buddy to the requested group\&. If no group is specified, then the buddy is moved to the default group\&. This command only works with users (not agents), at the moment\&.

Disconnect and leave mcabber(1) 

\fB/rename\fR nickname
Rename current buddy to the given nickname\&. This command does not work for groups, at the moment (but you can move the buddies to another group with the /move command)\&.

\fB/roster\fR hide_offline|show_offline|top|bottom
The roster command manipulates the roster/buddylist\&.

 \fBhide_offline\fR hide offline buddies
 \fBshow_offline\fR show offline buddies
 \fBtop\fR jump to the top of the roster
 \fBbottom\fR jump to the bottom of the roster

\fB/say\fR 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\&.

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


See the provided sample configuration file, which should be self\-documented\&.


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



Certainly a lot\&. Please tell me if you find one! :\-)


Written by Mikael BERTHE <\\fR>\&.
Originally based on cabber (Cabber homepage: <\fI\fR>), please consult the AUTHORS file for details\&.


Main web site: <\fI\fR>


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