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 |
236
|
101 Ctrl\-q Jump to the next unread message |
226
|
102 |
|
103 |
|
104 .SH "COMMANDS" |
|
105 |
|
106 .TP |
229
|
107 \fB/add\fR jid |
227
|
108 Add the jid Jabber user to our roster, and send a notification request to this buddy\&. |
226
|
109 |
|
110 .TP |
229
|
111 \fB/buffer\fR clear|top|bottom |
226
|
112 The buffer command manipulates the current buddy's buffer (chat window)\&. |
|
113 |
229
|
114 \fBclear\fR clear the current buddy chat window |
|
115 \fBtop\fR jump to the top of the current buddy chat buffer |
|
116 \fBbottom\fR jump to the bottom of the current buddy chat buffer |
226
|
117 |
|
118 .TP |
229
|
119 \fB/clear\fR |
227
|
120 The clear command is actually an alias for "/buffer clear"\&. |
|
121 |
|
122 .TP |
229
|
123 \fB/del\fR |
227
|
124 Delete the current buddy from our roster, unsubscribe from its presence notification and unsubscribe it from ours\&. |
226
|
125 |
|
126 .TP |
229
|
127 \fB/group\fR expand|shrink|toggle |
226
|
128 The group command changes the group display settings\&. |
|
129 |
229
|
130 \fBexpand\fR expand the current group tree in the roster (syn: unfold) |
|
131 \fBshrink\fR shrink the current group tree in the roster (syn: fold) |
|
132 \fBtoggle\fR toggle the fold/unfold state of the current tree |
226
|
133 |
|
134 .TP |
229
|
135 \fB/info\fR |
227
|
136 Display info on the selected entry (user, agent, group...)\&. |
|
137 |
|
138 .TP |
229
|
139 \fB/move\fR [groupname] |
|
140 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
|
141 |
|
142 .TP |
238
|
143 \fB/msay\fR begin|send|abort |
|
144 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\&. |
|
145 |
|
146 \fBbegin\fR enter multi\-line mode |
|
147 \fBsend\fR send the current multi\-line message to the currently selected buddy |
|
148 \fBabort\fR leave multi\-line mode without sending the message |
226
|
149 |
|
150 .TP |
229
|
151 \fB/rename\fR nickname |
|
152 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
|
153 |
|
154 .TP |
229
|
155 \fB/roster\fR hide_offline|show_offline|top|bottom |
|
156 The roster command manipulates the roster/buddylist\&. |
|
157 |
|
158 \fBhide_offline\fR hide offline buddies |
|
159 \fBshow_offline\fR show offline buddies |
|
160 \fBtop\fR jump to the top of the roster |
|
161 \fBbottom\fR jump to the bottom of the roster |
236
|
162 \fIunread_first\fR jump to the first unread message |
|
163 \fIunread_next\fR jump to the next unread message |
229
|
164 |
|
165 .TP |
|
166 \fB/say\fR text |
226
|
167 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\&. |
|
168 |
|
169 .TP |
229
|
170 \fB/status\fR [online|avail|invisible|free|dnd|busy|notavail|away] |
226
|
171 Set the current status\&. If no status is specified, display the current status\&. |
|
172 |
|
173 .SH "CONFIGURATION FILE" |
|
174 |
|
175 |
|
176 See the provided sample configuration file, which should be self\-documented\&. |
|
177 |
|
178 .SH "FILES" |
|
179 |
|
180 |
|
181 The following files can be used by mcabber(1): |
|
182 |
|
183 .nf |
|
184 |
|
185 $HOME/\&.mcabber/mcabberrc Default configuration file |
|
186 $HOME/\&.mcabberrc Configuration file used if no other has been found |
|
187 $HOME/\&.mcabber/histo/ Default directory for storing chat history files, if enabled |
|
188 |
|
189 .fi |
|
190 |
|
191 .SH "BUGS" |
|
192 |
|
193 |
|
194 Certainly a lot\&. Please tell me if you find one! :\-) |
|
195 |
|
196 .SH "AUTHOR" |
|
197 |
|
198 |
229
|
199 Written by Mikael BERTHE <\fImcabber@lilotux.net\fR>\&. |
|
200 Originally based on cabber (Cabber homepage: <\fIhttp://cabber.sourceforge.net\fR>), please consult the AUTHORS file for details\&. |
226
|
201 |
|
202 .SH "RESOURCES" |
|
203 |
|
204 |
229
|
205 Main web site: <\fIhttp://www.lilotux.net/~mikael/mcabber/\fR> |
226
|
206 |
|
207 .SH "COPYING" |
|
208 |
|
209 |
229
|
210 Copyright (C) 2005 Mikael Berthe\&. |
|
211 |
|
212 Some portions are Copyright (C) 2002\-2004 <cabber@ajmacias\&.com>\&. |
226
|
213 |
|
214 |
|
215 Free use of this software is granted under the terms of the GNU General Public License (GPL)\&. |
|
216 |