68 </li> |
58 </li> |
69 </ul> |
59 </ul> |
70 <h2>OPTIONS</h2> |
60 <h2>OPTIONS</h2> |
71 <dl> |
61 <dl> |
72 <dt><b> |
62 <dt><b> |
73 —help, -h |
63 --help, -h |
74 </b></dt> |
64 </b></dt> |
75 <dd> |
65 <dd> |
76 |
|
77 Quick help usage message |
66 Quick help usage message |
78 |
|
79 </dd> |
67 </dd> |
80 <dt><b> |
68 <dt><b> |
81 -f configfile |
69 -f configfile |
82 </b></dt> |
70 </b></dt> |
83 <dd> |
71 <dd> |
84 |
|
85 Use configuration file <b>configfile</b> |
72 Use configuration file <b>configfile</b> |
86 |
|
87 </dd> |
73 </dd> |
88 </dl> |
74 </dl> |
89 <h2>KEYS</h2> |
75 <h2>KEYS</h2> |
90 <p> |
76 <p>Text typing occurs in the <b>input line</b>; basic operations are supported |
91 Text typing occurs in the <b>input line</b>; basic operations are supported |
77 (left arrow, right arrow, home/end keys, insert, delete, backspace…).</p> |
92 (left arrow, right arrow, home/end keys, insert, delete, backspace…). |
78 <p>PageUp and PageDown keys are used to move in the roster.</p> |
93 </p> |
79 <p>To send a message, move to the choosen buddy in the buddylist, type your |
94 <p> |
|
95 PageUp and PageDown keys are used to move in the roster. |
|
96 </p> |
|
97 <p> |
|
98 To send a message, move to the choosen buddy in the buddylist, type your |
|
99 message and hit enter. If the line begins with a slash, this will be |
80 message and hit enter. If the line begins with a slash, this will be |
100 interpreted as a command (see the COMMAND section below). Hit escape to |
81 interpreted as a command (see the COMMAND section below). Hit escape to |
101 leave the chat mode. |
82 leave the chat mode.</p> |
102 </p> |
83 <p>Here is a quick description of the key bindings:</p> |
103 <p> |
|
104 Here is a quick description of the key bindings: |
|
105 </p> |
|
106 <table class="hlist"> |
84 <table class="hlist"> |
107 <tr valign="top"> |
85 <tr valign="top"> |
108 <td> |
86 <td> |
109 Ctrl-a |
87 Ctrl-a |
110 </td> |
88 </td> |
111 <td> |
89 <td> |
112 |
|
113 Go to the beginning of the input line |
90 Go to the beginning of the input line |
114 |
|
115 </td> |
91 </td> |
116 </tr> |
92 </tr> |
117 <tr valign="top"> |
93 <tr valign="top"> |
118 <td> |
94 <td> |
119 Ctrl-e |
95 Ctrl-e |
120 </td> |
96 </td> |
121 <td> |
97 <td> |
122 |
|
123 Go to the end of the input line |
98 Go to the end of the input line |
124 |
|
125 </td> |
99 </td> |
126 </tr> |
100 </tr> |
127 <tr valign="top"> |
101 <tr valign="top"> |
128 <td> |
102 <td> |
129 Ctrl-l |
103 Ctrl-l |
130 </td> |
104 </td> |
131 <td> |
105 <td> |
132 |
|
133 Force a resize |
106 Force a resize |
134 |
|
135 </td> |
107 </td> |
136 </tr> |
108 </tr> |
137 <tr valign="top"> |
109 <tr valign="top"> |
138 <td> |
110 <td> |
139 PgUp/PgDown |
111 PgUp/PgDown |
140 </td> |
112 </td> |
141 <td> |
113 <td> |
142 |
|
143 Move inside the roster (buddylist) |
114 Move inside the roster (buddylist) |
144 |
|
145 </td> |
115 </td> |
146 </tr> |
116 </tr> |
147 <tr valign="top"> |
117 <tr valign="top"> |
148 <td> |
118 <td> |
149 Tab |
119 Tab |
150 </td> |
120 </td> |
151 <td> |
121 <td> |
152 |
|
153 Complete current word, in the input line |
122 Complete current word, in the input line |
154 |
|
155 </td> |
123 </td> |
156 </tr> |
124 </tr> |
157 <tr valign="top"> |
125 <tr valign="top"> |
158 <td> |
126 <td> |
159 Ctrl-g |
127 Ctrl-g |
160 </td> |
128 </td> |
161 <td> |
129 <td> |
162 |
|
163 Cancel completion / ctrl-g |
130 Cancel completion / ctrl-g |
164 |
|
165 </td> |
131 </td> |
166 </tr> |
132 </tr> |
167 <tr valign="top"> |
133 <tr valign="top"> |
168 <td> |
134 <td> |
169 Ctrl-p/Ctrl-n |
135 Ctrl-p/Ctrl-n |
170 </td> |
136 </td> |
171 <td> |
137 <td> |
172 |
|
173 Scroll up/down half a screen in the buffer window (chat mode) |
138 Scroll up/down half a screen in the buffer window (chat mode) |
174 |
|
175 </td> |
139 </td> |
176 </tr> |
140 </tr> |
177 <tr valign="top"> |
141 <tr valign="top"> |
178 <td> |
142 <td> |
179 Ctrl-u |
143 Ctrl-u |
180 </td> |
144 </td> |
181 <td> |
145 <td> |
182 |
|
183 Delete from beginning of the line to the cursor |
146 Delete from beginning of the line to the cursor |
184 |
|
185 </td> |
147 </td> |
186 </tr> |
148 </tr> |
187 <tr valign="top"> |
149 <tr valign="top"> |
188 <td> |
150 <td> |
189 Ctrl-k |
151 Ctrl-k |
190 </td> |
152 </td> |
191 <td> |
153 <td> |
192 |
|
193 Delete from the cursor to the end of line |
154 Delete from the cursor to the end of line |
194 |
|
195 </td> |
155 </td> |
196 </tr> |
156 </tr> |
197 <tr valign="top"> |
157 <tr valign="top"> |
198 <td> |
158 <td> |
199 Ctrl-w |
159 Ctrl-w |
200 </td> |
160 </td> |
201 <td> |
161 <td> |
202 |
|
203 Backward kill word |
162 Backward kill word |
204 |
|
205 </td> |
163 </td> |
206 </tr> |
164 </tr> |
207 <tr valign="top"> |
165 <tr valign="top"> |
208 <td> |
166 <td> |
209 Ctrl-t |
167 Ctrl-t |
210 </td> |
168 </td> |
211 <td> |
169 <td> |
212 |
|
213 Transpose chars |
170 Transpose chars |
214 |
|
215 </td> |
171 </td> |
216 </tr> |
172 </tr> |
217 <tr valign="top"> |
173 <tr valign="top"> |
218 <td> |
174 <td> |
219 Ctrl-q |
175 Ctrl-q |
220 </td> |
176 </td> |
221 <td> |
177 <td> |
222 |
|
223 Jump to the next unread message |
178 Jump to the next unread message |
224 |
|
225 </td> |
179 </td> |
226 </tr> |
180 </tr> |
227 </table> |
181 </table> |
228 <h2>COMMANDS</h2> |
182 <h2>COMMANDS</h2> |
229 <dl> |
183 <dl> |
230 <dt><b> |
184 <dt><b> |
231 /add jid [nickname] |
185 /add jid [nickname] |
232 </b></dt> |
186 </b></dt> |
233 <dd> |
187 <dd> |
234 |
|
235 Add the <b>jid</b> Jabber user to our roster (default group), and send a |
188 Add the <b>jid</b> Jabber user to our roster (default group), and send a |
236 notification request to this buddy. If no nickname is specified, the |
189 notification request to this buddy. If no nickname is specified, the |
237 jid is used. |
190 jid is used. |
238 |
|
239 </dd> |
191 </dd> |
240 <dt><b> |
192 <dt><b> |
241 /buffer clear|top|bottom |
193 /buffer clear|top|bottom |
242 </b></dt> |
194 </b></dt> |
243 <dd> |
195 <dd> |
244 |
|
245 The <b>buffer</b> command manipulates the current buddy's buffer |
196 The <b>buffer</b> command manipulates the current buddy's buffer |
246 (chat window). |
197 (chat window). |
247 |
|
248 <table class="hlist"> |
198 <table class="hlist"> |
249 <tr valign="top"> |
199 <tr valign="top"> |
250 <td> |
200 <td> |
251 <b>clear</b> |
201 <b>clear</b> |
252 </td> |
202 </td> |
253 <td> |
203 <td> |
254 |
|
255 clear the current buddy chat window |
204 clear the current buddy chat window |
256 |
|
257 </td> |
205 </td> |
258 </tr> |
206 </tr> |
259 <tr valign="top"> |
207 <tr valign="top"> |
260 <td> |
208 <td> |
261 <b>top</b> |
209 <b>top</b> |
262 </td> |
210 </td> |
263 <td> |
211 <td> |
264 |
|
265 jump to the top of the current buddy chat buffer |
212 jump to the top of the current buddy chat buffer |
266 |
|
267 </td> |
213 </td> |
268 </tr> |
214 </tr> |
269 <tr valign="top"> |
215 <tr valign="top"> |
270 <td> |
216 <td> |
271 <b>bottom</b> |
217 <b>bottom</b> |
272 </td> |
218 </td> |
273 <td> |
219 <td> |
274 |
|
275 jump to the bottom of the current buddy chat buffer |
220 jump to the bottom of the current buddy chat buffer |
276 |
|
277 </td> |
221 </td> |
278 </tr> |
222 </tr> |
279 </table> |
223 </table> |
280 </dd> |
224 </dd> |
281 <dt><b> |
225 <dt><b> |
282 /clear |
226 /clear |
283 </b></dt> |
227 </b></dt> |
284 <dd> |
228 <dd> |
285 |
|
286 The <b>clear</b> command is actually an alias for "/buffer clear". |
229 The <b>clear</b> command is actually an alias for "/buffer clear". |
287 |
|
288 </dd> |
230 </dd> |
289 <dt><b> |
231 <dt><b> |
290 /del |
232 /del |
291 </b></dt> |
233 </b></dt> |
292 <dd> |
234 <dd> |
293 |
|
294 Delete the current buddy from our roster, unsubscribe from its presence |
235 Delete the current buddy from our roster, unsubscribe from its presence |
295 notification and unsubscribe it from ours. |
236 notification and unsubscribe it from ours. |
296 |
|
297 </dd> |
237 </dd> |
298 <dt><b> |
238 <dt><b> |
299 /group fold|unfold|toggle |
239 /group fold|unfold|toggle |
300 </b></dt> |
240 </b></dt> |
301 <dd> |
241 <dd> |
302 |
|
303 The <b>group</b> command changes the current group display. |
242 The <b>group</b> command changes the current group display. |
304 |
|
305 <table class="hlist"> |
243 <table class="hlist"> |
306 <tr valign="top"> |
244 <tr valign="top"> |
307 <td> |
245 <td> |
308 <b>fold</b> |
246 <b>fold</b> |
309 </td> |
247 </td> |
310 <td> |
248 <td> |
311 |
|
312 fold (shrink) the current group tree in the roster |
249 fold (shrink) the current group tree in the roster |
313 |
|
314 </td> |
250 </td> |
315 </tr> |
251 </tr> |
316 <tr valign="top"> |
252 <tr valign="top"> |
317 <td> |
253 <td> |
318 <b>unfold</b> |
254 <b>unfold</b> |
319 </td> |
255 </td> |
320 <td> |
256 <td> |
321 |
|
322 unfold (expand) the current group tree in the roster |
257 unfold (expand) the current group tree in the roster |
323 |
|
324 </td> |
258 </td> |
325 </tr> |
259 </tr> |
326 <tr valign="top"> |
260 <tr valign="top"> |
327 <td> |
261 <td> |
328 <b>toggle</b> |
262 <b>toggle</b> |
329 </td> |
263 </td> |
330 <td> |
264 <td> |
331 |
|
332 toggle the state (fold/unfold) of the current tree |
265 toggle the state (fold/unfold) of the current tree |
333 |
|
334 </td> |
266 </td> |
335 </tr> |
267 </tr> |
336 </table> |
268 </table> |
337 </dd> |
269 </dd> |
338 <dt><b> |
270 <dt><b> |
339 /info |
271 /info |
340 </b></dt> |
272 </b></dt> |
341 <dd> |
273 <dd> |
342 |
|
343 Display info on the selected entry (user, agent, group…). |
274 Display info on the selected entry (user, agent, group…). |
344 |
|
345 </dd> |
275 </dd> |
346 <dt><b> |
276 <dt><b> |
347 /move [groupname] |
277 /move [groupname] |
348 </b></dt> |
278 </b></dt> |
349 <dd> |
279 <dd> |
350 |
|
351 Move the current buddy to the requested group. If no group is |
280 Move the current buddy to the requested group. If no group is |
352 specified, then the buddy is moved to the default group. |
281 specified, then the buddy is moved to the default group. |
353 This command only works with users (not agents), at the moment. |
282 This command only works with users (not agents), at the moment. |
354 |
283 </dd> |
355 </dd> |
284 <dt><b> |
356 <dt><b> |
285 /msay begin|verbatim|send|abort |
357 /msay begin|send|abort |
286 </b></dt> |
358 </b></dt> |
287 <dd> |
359 <dd> |
|
360 |
|
361 Send a multi-line message. To write a single message with several |
288 Send a multi-line message. To write a single message with several |
362 lines, the <b>multi-line mode</b> should be used. In multi-line mode, |
289 lines, the <b>multi-line mode</b> should be used. In multi-line mode, |
363 each line (except command lines) typed in the input line will |
290 each line (except command lines) typed in the input line will |
364 be added to the multi-line message. Once the message is finished, it |
291 be added to the multi-line message. Once the message is finished, it |
365 can be sent to the current selected buddy with the "msay /send" |
292 can be sent to the current selected buddy with the "msay /send" |
366 command. |
293 command. The <b>verbatim</b> multi-line mode disables commands, so that it |
367 |
294 is possible to enter lines starting with a slash. Only the "/msay" |
|
295 command (with send or abort parameters) can be used to exit verbatim mode. |
368 <table class="hlist"> |
296 <table class="hlist"> |
369 <tr valign="top"> |
297 <tr valign="top"> |
370 <td> |
298 <td> |
371 <b>begin</b> |
299 <b>begin</b> |
372 </td> |
300 </td> |
373 <td> |
301 <td> |
374 |
|
375 enter multi-line mode |
302 enter multi-line mode |
376 |
303 </td> |
|
304 </tr> |
|
305 <tr valign="top"> |
|
306 <td> |
|
307 <b>verbatim</b> |
|
308 </td> |
|
309 <td> |
|
310 enter verbatim multi-line mode |
377 </td> |
311 </td> |
378 </tr> |
312 </tr> |
379 <tr valign="top"> |
313 <tr valign="top"> |
380 <td> |
314 <td> |
381 <b>send</b> |
315 <b>send</b> |
382 </td> |
316 </td> |
383 <td> |
317 <td> |
384 |
|
385 send the current multi-line message to the currently selected buddy |
318 send the current multi-line message to the currently selected buddy |
386 |
|
387 </td> |
319 </td> |
388 </tr> |
320 </tr> |
389 <tr valign="top"> |
321 <tr valign="top"> |
390 <td> |
322 <td> |
391 <b>abort</b> |
323 <b>abort</b> |
392 </td> |
324 </td> |
393 <td> |
325 <td> |
394 |
|
395 leave multi-line mode without sending the message |
326 leave multi-line mode without sending the message |
396 |
|
397 </td> |
327 </td> |
398 </tr> |
328 </tr> |
399 </table> |
329 </table> |
400 </dd> |
330 </dd> |
401 <dt><b> |
331 <dt><b> |
402 /quit |
332 /quit |
403 </b></dt> |
333 </b></dt> |
404 <dd> |
334 <dd> |
405 |
|
406 Disconnect and leave <tt>mcabber(1)</tt>. |
335 Disconnect and leave <tt>mcabber(1)</tt>. |
407 |
|
408 </dd> |
336 </dd> |
409 <dt><b> |
337 <dt><b> |
410 /rename nickname |
338 /rename nickname |
411 </b></dt> |
339 </b></dt> |
412 <dd> |
340 <dd> |
413 |
|
414 Rename current buddy to the given nickname. |
341 Rename current buddy to the given nickname. |
415 This command does not work for groups, at the moment (but you can move |
342 This command does not work for groups, at the moment (but you can move |
416 the buddies to another group with the /move command). |
343 the buddies to another group with the /move command). |
417 |
|
418 </dd> |
344 </dd> |
419 <dt><b> |
345 <dt><b> |
420 /roster hide_offline|show_offline|top|bottom |
346 /roster hide_offline|show_offline|top|bottom |
421 </b></dt> |
347 </b></dt> |
422 <dd> |
348 <dd> |
423 |
|
424 The <b>roster</b> command manipulates the roster/buddylist. |
349 The <b>roster</b> command manipulates the roster/buddylist. |
425 |
|
426 <table class="hlist"> |
350 <table class="hlist"> |
427 <tr valign="top"> |
351 <tr valign="top"> |
428 <td> |
352 <td> |
429 <b>hide_offline</b> |
353 <b>hide_offline</b> |
430 </td> |
354 </td> |
431 <td> |
355 <td> |
432 |
|
433 hide offline buddies |
356 hide offline buddies |
434 |
|
435 </td> |
357 </td> |
436 </tr> |
358 </tr> |
437 <tr valign="top"> |
359 <tr valign="top"> |
438 <td> |
360 <td> |
439 <b>show_offline</b> |
361 <b>show_offline</b> |
440 </td> |
362 </td> |
441 <td> |
363 <td> |
442 |
|
443 show offline buddies |
364 show offline buddies |
444 |
|
445 </td> |
365 </td> |
446 </tr> |
366 </tr> |
447 <tr valign="top"> |
367 <tr valign="top"> |
448 <td> |
368 <td> |
449 <b>top</b> |
369 <b>top</b> |
450 </td> |
370 </td> |
451 <td> |
371 <td> |
452 |
|
453 jump to the top of the roster |
372 jump to the top of the roster |
454 |
|
455 </td> |
373 </td> |
456 </tr> |
374 </tr> |
457 <tr valign="top"> |
375 <tr valign="top"> |
458 <td> |
376 <td> |
459 <b>bottom</b> |
377 <b>bottom</b> |
460 </td> |
378 </td> |
461 <td> |
379 <td> |
462 |
|
463 jump to the bottom of the roster |
380 jump to the bottom of the roster |
464 |
|
465 </td> |
381 </td> |
466 </tr> |
382 </tr> |
467 <tr valign="top"> |
383 <tr valign="top"> |
468 <td> |
384 <td> |
469 <b>unread_first</b> |
385 <b>unread_first</b> |
470 </td> |
386 </td> |
471 <td> |
387 <td> |
472 |
|
473 jump to the first unread message |
388 jump to the first unread message |
474 |
|
475 </td> |
389 </td> |
476 </tr> |
390 </tr> |
477 <tr valign="top"> |
391 <tr valign="top"> |
478 <td> |
392 <td> |
479 <b>unread_next</b> |
393 <b>unread_next</b> |
480 </td> |
394 </td> |
481 <td> |
395 <td> |
482 |
|
483 jump to the next unread message |
396 jump to the next unread message |
484 |
|
485 </td> |
397 </td> |
486 </tr> |
398 </tr> |
487 </table> |
399 </table> |
488 </dd> |
400 </dd> |
489 <dt><b> |
401 <dt><b> |
490 /say text |
402 /say text |
491 </b></dt> |
403 </b></dt> |
492 <dd> |
404 <dd> |
493 |
|
494 Send the text message to the currently selected buddy. Can be useful |
405 Send the text message to the currently selected buddy. Can be useful |
495 if you want to send a message beginning with a slash, for example. |
406 if you want to send a message beginning with a slash, for example. |
496 |
|
497 </dd> |
407 </dd> |
498 <dt><b> |
408 <dt><b> |
499 /status [online|avail|invisible|free|dnd|busy|notavail|away] |
409 /status [online|avail|invisible|free|dnd|busy|notavail|away] |
500 </b></dt> |
410 </b></dt> |
501 <dd> |
411 <dd> |
502 |
|
503 Set the current status. If no status is specified, display the |
412 Set the current status. If no status is specified, display the |
504 current status. |
413 current status. |
505 |
|
506 </dd> |
414 </dd> |
507 </dl> |
415 </dl> |
508 <h2>CONFIGURATION FILE</h2> |
416 <h2>CONFIGURATION FILE</h2> |
509 <p> |
417 <p>See the provided sample configuration file, which should be self-documented.</p> |
510 See the provided sample configuration file, which should be self-documented. |
|
511 </p> |
|
512 <h2>FILES</h2> |
418 <h2>FILES</h2> |
513 <p> |
419 <p>The following files can be used by <tt>mcabber(1)</tt>:</p> |
514 The following files can be used by <tt>mcabber(1)</tt>: |
420 <div class="literalparagraph"><pre>$HOME/.mcabber/mcabberrc Default configuration file |
515 </p> |
|
516 <div class="literalparagraph"><pre> |
|
517 $HOME/.mcabber/mcabberrc Default configuration file |
|
518 $HOME/.mcabberrc Configuration file used if no other has been found |
421 $HOME/.mcabberrc Configuration file used if no other has been found |
519 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled |
422 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled</pre></div> |
520 </pre></div> |
|
521 <h2>BUGS</h2> |
423 <h2>BUGS</h2> |
522 <p> |
424 <p>Certainly a lot. Please tell me if you find one! :-)</p> |
523 Certainly a lot. Please tell me if you find one! :-) |
|
524 </p> |
|
525 <h2>AUTHOR</h2> |
425 <h2>AUTHOR</h2> |
526 <p> |
426 <p>Written by <a href="mailto:mcabber@lilotux.net">Mikael BERTHE</a>.<br /> |
527 Written by <a href="mailto:mcabber@lilotux.net">Mikael BERTHE</a>.<br /> |
|
528 Originally based on <a href="http://cabber.sourceforge.net">Cabber</a>, please |
427 Originally based on <a href="http://cabber.sourceforge.net">Cabber</a>, please |
529 consult the AUTHORS file for details. |
428 consult the AUTHORS file for details.</p> |
530 </p> |
|
531 <h2>RESOURCES</h2> |
429 <h2>RESOURCES</h2> |
532 <p> |
430 <p><a href="http://www.lilotux.net/~mikael/mcabber/">Main web site</a></p> |
533 <a href="http://www.lilotux.net/~mikael/mcabber/">Main web site</a> |
|
534 </p> |
|
535 <h2>COPYING</h2> |
431 <h2>COPYING</h2> |
536 <p> |
432 <p>Copyright © 2005 Mikael Berthe.<br /> |
537 Copyright © 2005 Mikael Berthe.<br /> |
433 Some portions are Copyright © 2002-2004 <a href="mailto:cabber@ajmacias.com">cabber@ajmacias.com</a>.</p> |
538 Some portions are Copyright © 2002-2004 <a href="mailto:cabber@ajmacias.com">cabber@ajmacias.com</a>. |
434 <p>Free use of this software is granted under the terms of the GNU General Public |
539 </p> |
435 License (GPL).</p> |
540 <p> |
|
541 Free use of this software is granted under the terms of the GNU General Public |
|
542 License (GPL). |
|
543 </p> |
|
544 <div id="footer"> |
436 <div id="footer"> |
545 <p> |
437 <p> |
546 Version 0.6.2<br /> |
438 Version 0.6.2<br /> |
547 Last updated 14-Jun-2005 23:30:26 CEST |
439 Last updated 02-Jul-2005 00:36:19 CEST |
548 </p> |
440 </p> |
549 </div> |
441 </div> |
550 </div> |
442 </div> |
551 </body> |
443 </body> |
552 </html> |
444 </html> |