Mercurial > hg
view mcabber/doc/mcabber.1 @ 229:bfc14cfb068e
[/trunk] Changeset 241 by mikael
* Update doc (man + html).
author | mikael |
---|---|
date | Tue, 07 Jun 2005 18:35:04 +0000 |
parents | 365818971234 |
children | 72fd1273f2b7 |
line wrap: on
line source
.\"Generated by db2man.xsl. Don't modify this, modify the source. .de Sh \" Subsection .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Ip \" List item .br .ie \\n(.$>=3 .ne \\$3 .el .ne 3 .IP "\\$1" \\$2 .. .TH "MCABBER" 1 "" "" "" .SH NAME mcabber \- a simple Jabber console client .SH "SYNOPSIS" mcabber [ \-f configfile ] [ --help | \-h ] .SH "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 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 \(bu SSL support\&. .TP \(bu History logging: If enabled (see the CONFIGURATION FILE section), mcabber(1) can save discussions to history log files\&. .TP \(bu Commands completion: If possible, mcabber(1) will try to complete your command line if you hit the Tab key\&. .TP \(bu 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)\&. .LP .SH "OPTIONS" .TP --help, \-h Quick help usage message .TP \-f configfile Use configuration file configfile .SH "KEYS" 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) .SH "COMMANDS" .TP \fB/add\fR jid Add the jid Jabber user to our roster, and send a notification request to this buddy\&. .TP \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 .TP \fB/clear\fR The clear command is actually an alias for "/buffer clear"\&. .TP \fB/del\fR Delete the current buddy from our roster, unsubscribe from its presence notification and unsubscribe it from ours\&. .TP \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 .TP \fB/info\fR Display info on the selected entry (user, agent, group...)\&. .TP \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\&. .TP \fB/quit\fR Disconnect and leave mcabber(1) .TP \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)\&. .TP \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 .TP \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\&. .TP \fB/status\fR [online|avail|invisible|free|dnd|busy|notavail|away] Set the current status\&. If no status is specified, display the current status\&. .SH "CONFIGURATION FILE" See the provided sample configuration file, which should be self\-documented\&. .SH "FILES" The following files can be used by mcabber(1): .nf $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 .fi .SH "BUGS" Certainly a lot\&. Please tell me if you find one! :\-) .SH "AUTHOR" Written by Mikael BERTHE <\fImcabber@lilotux.net\fR>\&. Originally based on cabber (Cabber homepage: <\fIhttp://cabber.sourceforge.net\fR>), please consult the AUTHORS file for details\&. .SH "RESOURCES" Main web site: <\fIhttp://www.lilotux.net/~mikael/mcabber/\fR> .SH "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)\&.