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 |
227
|
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\&. Sending a message also enables chat mode implicitly\&. |
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 |
|
50 Commands completion: If possible, mcabber(1) will try to complete your commands line if you hit the Tab key\&. |
|
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 |
227
|
69 Text typing happens 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 |
|
78 Here is a quick description of the key bindings: |
|
79 |
|
80 |
|
81 Ctrl\-a |
|
82 |
|
83 Go to the beginning of the input line |
|
84 |
|
85 Ctrl\-e |
|
86 |
|
87 Go to the end of the input line |
|
88 |
|
89 Ctrl\-l |
|
90 |
|
91 Force a resize |
|
92 |
|
93 PgUp/PgDown |
|
94 |
|
95 Move inside the roster (buddylist) |
|
96 |
|
97 Tab |
|
98 |
|
99 Complete current word, in the input line |
|
100 |
|
101 Ctrl\-g |
|
102 |
|
103 Cancel completion / ctrl\-g |
|
104 |
|
105 Ctrl\-p/Ctrl\-n |
|
106 |
|
107 Scroll up/down half a screen in the buffer window (chat mode) |
|
108 |
|
109 Ctrl\-u |
|
110 |
|
111 Delete from beginning of the line to the cursor |
|
112 |
|
113 Ctrl\-k |
|
114 |
|
115 Delete from the cursor to the end of line |
|
116 |
|
117 Ctrl\-w |
|
118 |
|
119 Backward kill word |
|
120 |
|
121 Ctrl\-t |
|
122 |
|
123 Transpose chars |
|
124 |
|
125 Ctrl\-q |
|
126 |
|
127 Jump to the next unread message (Not yet implemented) |
|
128 |
|
129 |
|
130 .SH "COMMANDS" |
|
131 |
|
132 .TP |
|
133 /add jid |
227
|
134 Add the jid Jabber user to our roster, and send a notification request to this buddy\&. |
226
|
135 |
|
136 .TP |
|
137 /buffer clear|top|bottom |
|
138 The buffer command manipulates the current buddy's buffer (chat window)\&. |
227
|
139 \fIclear\fR |
226
|
140 |
|
141 clear the current buddy chat window |
|
142 |
227
|
143 \fItop\fR |
226
|
144 |
|
145 jump to the top of the current buddy chat buffer |
|
146 |
227
|
147 \fIbottom\fR |
226
|
148 |
|
149 jump to the bottom of the current buddy chat buffer |
|
150 |
|
151 |
|
152 .TP |
|
153 /clear |
227
|
154 The clear command is actually an alias for "/buffer clear"\&. |
|
155 |
|
156 .TP |
|
157 /del |
|
158 Delete the current buddy from our roster, unsubscribe from its presence notification and unsubscribe it from ours\&. |
226
|
159 |
|
160 .TP |
|
161 /group expand|shrink|toggle |
|
162 The group command changes the group display settings\&. |
227
|
163 \fIexpand\fR |
226
|
164 |
227
|
165 expand the current group tree in the roster (syn: \fIunfold\fR) |
226
|
166 |
227
|
167 \fIshrink\fR |
226
|
168 |
227
|
169 shrink the current group tree in the roster (syn: \fIfold\fR) |
226
|
170 |
227
|
171 \fItoggle\fR |
226
|
172 |
|
173 toggle the fold/unfold state of the current tree |
|
174 |
|
175 |
|
176 .TP |
|
177 /info |
227
|
178 Display info on the selected entry (user, agent, group...)\&. |
|
179 |
|
180 .TP |
|
181 /move [groupname] |
|
182 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), right now\&. |
226
|
183 |
|
184 .TP |
|
185 /quit |
227
|
186 Disconnect and leave mcabber(1)\&. |
|
187 |
|
188 .TP |
|
189 /rename nickname |
|
190 Rename current buddy to the given nickname\&. This command does not work for groups, right now (but you can move the buddies to another group with the /move command)\&. |
226
|
191 |
|
192 .TP |
|
193 /roster hide_offline|show_offline|top|bottom |
|
194 The roster command manipulates the roster/buddylist\&. |
227
|
195 \fIhide_offline\fR |
226
|
196 |
|
197 hide offline buddies |
|
198 |
227
|
199 \fIshow_offline\fR |
226
|
200 |
|
201 show offline buddies |
|
202 |
227
|
203 \fItop\fR |
226
|
204 |
|
205 jump to the top of the roster |
|
206 |
227
|
207 \fIbottom\fR |
226
|
208 |
|
209 jump to the bottom of the roster |
|
210 |
|
211 |
|
212 .TP |
|
213 /say text |
|
214 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\&. |
|
215 |
|
216 .TP |
|
217 /status [online|avail|invisible|free|dnd|busy|notavail|away] |
|
218 Set the current status\&. If no status is specified, display the current status\&. |
|
219 |
|
220 .SH "CONFIGURATION FILE" |
|
221 |
|
222 |
|
223 See the provided sample configuration file, which should be self\-documented\&. |
|
224 |
|
225 .SH "FILES" |
|
226 |
|
227 |
|
228 The following files can be used by mcabber(1): |
|
229 |
|
230 .nf |
|
231 |
|
232 $HOME/\&.mcabber/mcabberrc Default configuration file |
|
233 $HOME/\&.mcabberrc Configuration file used if no other has been found |
|
234 $HOME/\&.mcabber/histo/ Default directory for storing chat history files, if enabled |
|
235 |
|
236 .fi |
|
237 |
|
238 .SH "BUGS" |
|
239 |
|
240 |
|
241 Certainly a lot\&. Please tell me if you find one! :\-) |
|
242 |
|
243 .SH "AUTHOR" |
|
244 |
|
245 |
|
246 Written by Mikael BERTHE: \fImailto:mcabber@lilotux.net\fR\&. Originally based on Cabber: \fIhttp://cabber.sourceforge.net\fR, please consult the AUTHORS file for details\&. |
|
247 |
|
248 .SH "RESOURCES" |
|
249 |
|
250 |
|
251 Main web site: \fIhttp://www.lilotux.net/~mikael/mcabber/\fR |
|
252 |
|
253 .SH "COPYING" |
|
254 |
|
255 |
|
256 Copyright (C) 2005 Mikael Berthe\&. Some portions are Copyright (C) 2002\-2004 cabber@ajmacias\&.com: \fImailto:cabber@ajmacias.com\fR\&. |
|
257 |
|
258 |
|
259 Free use of this software is granted under the terms of the GNU General Public License (GPL)\&. |
|
260 |