author | Mikael Berthe <mikael@lilotux.net> |
Tue, 05 Jul 2005 20:48:44 +0100 | |
changeset 277 | 4d7040cff8ee |
parent 265 | 49e9e02dd6d0 |
child 286 | a3d65d7f0bc3 |
permissions | -rw-r--r-- |
226 | 1 |
.\"Generated by db2man.xsl. Don't modify this, modify the source. |
2 |
.de Sh \" Subsection |
|
3 |
.br |
|
4 |
.if t .Sp |
|
5 |
.ne 5 |
|
6 |
.PP |
|
7 |
\fB\\$1\fR |
|
8 |
.PP |
|
9 |
.. |
|
10 |
.de Sp \" Vertical space (when we can't use .PP) |
|
11 |
.if t .sp .5v |
|
12 |
.if n .sp |
|
13 |
.. |
|
14 |
.de Ip \" List item |
|
15 |
.br |
|
16 |
.ie \\n(.$>=3 .ne \\$3 |
|
17 |
.el .ne 3 |
|
18 |
.IP "\\$1" \\$2 |
|
19 |
.. |
|
20 |
.TH "MCABBER" 1 "" "" "" |
|
21 |
.SH NAME |
|
22 |
mcabber \- a simple Jabber console client |
|
23 |
.SH "SYNOPSIS" |
|
24 |
||
25 |
||
26 |
mcabber [ \-f configfile ] [ --help | \-h ] |
|
27 |
||
28 |
.SH "DESCRIPTION" |
|
29 |
||
30 |
||
227 | 31 |
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\&. |
226 | 32 |
|
33 |
||
227 | 34 |
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\&. |
226 | 35 |
|
36 |
||
229 | 37 |
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\&. |
226 | 38 |
|
39 |
||
40 |
Here are some of the features of mcabber: |
|
41 |
||
42 |
.TP 3 |
|
43 |
\(bu |
|
44 |
SSL support\&. |
|
45 |
.TP |
|
46 |
\(bu |
|
47 |
History logging: If enabled (see the CONFIGURATION FILE section), mcabber(1) can save discussions to history log files\&. |
|
48 |
.TP |
|
49 |
\(bu |
|
229 | 50 |
Commands completion: If possible, mcabber(1) will try to complete your command line if you hit the Tab key\&. |
226 | 51 |
.TP |
52 |
\(bu |
|
53 |
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)\&. |
|
54 |
.LP |
|
55 |
||
56 |
.SH "OPTIONS" |
|
57 |
||
58 |
.TP |
|
59 |
--help, \-h |
|
60 |
Quick help usage message |
|
61 |
||
62 |
.TP |
|
63 |
\-f configfile |
|
64 |
Use configuration file configfile |
|
65 |
||
66 |
.SH "KEYS" |
|
67 |
||
68 |
||
229 | 69 |
Text typing occurs in the \fIinput line\fR; basic operations are supported (left arrow, right arrow, home/end keys, insert, delete, backspace...)\&. |
226 | 70 |
|
71 |
||
72 |
PageUp and PageDown keys are used to move in the roster\&. |
|
73 |
||
74 |
||
75 |
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\&. |
|
76 |
||
77 |
Here is a quick description of the key bindings: |
|
78 |
||
229 | 79 |
Ctrl\-a Go to the beginning of the input line |
226 | 80 |
|
229 | 81 |
Ctrl\-e Go to the end of the input line |
226 | 82 |
|
229 | 83 |
Ctrl\-l Force a resize |
226 | 84 |
|
229 | 85 |
PgUp/PgDown Move inside the roster (buddylist) |
226 | 86 |
|
229 | 87 |
Tab Complete current word, in the input line |
226 | 88 |
|
229 | 89 |
Ctrl\-g Cancel completion / ctrl\-g |
226 | 90 |
|
229 | 91 |
Ctrl\-p/Ctrl\-n Scroll up/down half a screen in the buffer window (chat mode) |
226 | 92 |
|
229 | 93 |
Ctrl\-u Delete from beginning of the line to the cursor |
226 | 94 |
|
229 | 95 |
Ctrl\-k Delete from the cursor to the end of line |
226 | 96 |
|
229 | 97 |
Ctrl\-w Backward kill word |
226 | 98 |
|
229 | 99 |
Ctrl\-t Transpose chars |
226 | 100 |
|
263 | 101 |
Ctrl\-o Accept line and put the next history line in the input line (accept\-line\-and\-down\-history) |
102 |
||
236 | 103 |
Ctrl\-q Jump to the next unread message |
226 | 104 |
|
105 |
||
106 |
.SH "COMMANDS" |
|
107 |
||
108 |
.TP |
|
245 | 109 |
\fB/add\fR jid [nickname] |
110 |
Add the jid Jabber user to our roster (default group), and send a notification request to this buddy\&. If no nickname is specified, the jid is used\&. |
|
226 | 111 |
|
112 |
.TP |
|
229 | 113 |
\fB/buffer\fR clear|top|bottom |
226 | 114 |
The buffer command manipulates the current buddy's buffer (chat window)\&. |
115 |
||
229 | 116 |
\fBclear\fR clear the current buddy chat window |
265 | 117 |
\fBtop\fR jump to the top of the current buddy chat buffer |
229 | 118 |
\fBbottom\fR jump to the bottom of the current buddy chat buffer |
226 | 119 |
|
120 |
.TP |
|
229 | 121 |
\fB/clear\fR |
227 | 122 |
The clear command is actually an alias for "/buffer clear"\&. |
123 |
||
124 |
.TP |
|
229 | 125 |
\fB/del\fR |
227 | 126 |
Delete the current buddy from our roster, unsubscribe from its presence notification and unsubscribe it from ours\&. |
226 | 127 |
|
128 |
.TP |
|
240 | 129 |
\fB/group\fR fold|unfold|toggle |
130 |
The group command changes the current group display\&. |
|
226 | 131 |
|
265 | 132 |
\fBfold\fR fold (shrink) the current group tree in the roster |
133 |
\fBunfold\fR unfold (expand) the current group tree in the roster |
|
134 |
\fBtoggle\fR toggle the state (fold/unfold) of the current tree |
|
226 | 135 |
|
136 |
.TP |
|
229 | 137 |
\fB/info\fR |
227 | 138 |
Display info on the selected entry (user, agent, group...)\&. |
139 |
||
140 |
.TP |
|
229 | 141 |
\fB/move\fR [groupname] |
142 |
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\&. |
|
226 | 143 |
|
144 |
.TP |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
245
diff
changeset
|
145 |
\fB/msay\fR begin|verbatim|send|abort |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
245
diff
changeset
|
146 |
Send a multi\-line message\&. To write a single message with several lines, the \fImulti\-line mode\fR should be used\&. In multi\-line mode, each line (except command lines) typed in the input line will be added to the multi\-line message\&. Once the message is finished, it can be sent to the current selected buddy with the "msay /send" command\&. The \fIverbatim\fR multi\-line mode disables commands, so that it is possible to enter lines starting with a slash\&. Only the "/msay" command (with send or abort parameters) can be used to exit verbatim mode\&. |
238 | 147 |
|
265 | 148 |
\fBbegin\fR enter multi\-line mode |
149 |
\fBverbatim\fR enter verbatim multi\-line mode |
|
150 |
\fBsend\fR send the current multi\-line message to the currently selected buddy |
|
151 |
\fBabort\fR leave multi\-line mode without sending the message |
|
226 | 152 |
|
153 |
.TP |
|
229 | 154 |
\fB/rename\fR nickname |
155 |
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)\&. |
|
226 | 156 |
|
157 |
.TP |
|
265 | 158 |
\fB/roster\fR |
159 |
The roster command manipulates the roster/buddylist\&. Here are the available parameters: |
|
229 | 160 |
|
265 | 161 |
\fBbottom\fR jump to the bottom of the roster |
162 |
\fBtop\fR jump to the top of the roster |
|
163 |
\fBhide_offline\fR hide offline buddies |
|
164 |
\fBshow_offline\fR show offline buddies |
|
165 |
\fBsearch\fR bud search for a buddy with a name or buddy containing "bud" (only in the displayed buddylist) |
|
166 |
\fBunread_first\fR jump to the first unread message |
|
167 |
\fBunread_next\fR jump to the next unread message |
|
229 | 168 |
|
169 |
.TP |
|
170 |
\fB/say\fR text |
|
226 | 171 |
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\&. |
172 |
||
173 |
.TP |
|
277
4d7040cff8ee
Remove busy/occupied status, which does not really exist
Mikael Berthe <mikael@lilotux.net>
parents:
265
diff
changeset
|
174 |
\fB/status\fR [online|avail|invisible|free|dnd|notavail|away] |
226 | 175 |
Set the current status\&. If no status is specified, display the current status\&. |
176 |
||
177 |
.SH "CONFIGURATION FILE" |
|
178 |
||
179 |
||
180 |
See the provided sample configuration file, which should be self\-documented\&. |
|
181 |
||
182 |
.SH "FILES" |
|
183 |
||
184 |
||
185 |
The following files can be used by mcabber(1): |
|
186 |
||
187 |
.nf |
|
188 |
||
189 |
$HOME/\&.mcabber/mcabberrc Default configuration file |
|
190 |
$HOME/\&.mcabberrc Configuration file used if no other has been found |
|
191 |
$HOME/\&.mcabber/histo/ Default directory for storing chat history files, if enabled |
|
192 |
||
193 |
.fi |
|
194 |
||
195 |
.SH "BUGS" |
|
196 |
||
197 |
||
198 |
Certainly a lot\&. Please tell me if you find one! :\-) |
|
199 |
||
200 |
.SH "AUTHOR" |
|
201 |
||
202 |
||
229 | 203 |
Written by Mikael BERTHE <\fImcabber@lilotux.net\fR>\&. |
204 |
Originally based on cabber (Cabber homepage: <\fIhttp://cabber.sourceforge.net\fR>), please consult the AUTHORS file for details\&. |
|
226 | 205 |
|
206 |
.SH "RESOURCES" |
|
207 |
||
208 |
||
229 | 209 |
Main web site: <\fIhttp://www.lilotux.net/~mikael/mcabber/\fR> |
226 | 210 |
|
211 |
.SH "COPYING" |
|
212 |
||
213 |
||
229 | 214 |
Copyright (C) 2005 Mikael Berthe\&. |
215 |
||
216 |
Some portions are Copyright (C) 2002\-2004 <cabber@ajmacias\&.com>\&. |
|
226 | 217 |
|
218 |
||
219 |
Free use of this software is granted under the terms of the GNU General Public License (GPL)\&. |
|
220 |