Mercurial > ~mikael > mcabber > hg

comparison mcabber/doc/mcabber.1 @ 1096:3d92e648a8db

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update manpage
author Mikael Berthe <mikael@lilotux.net>
date Sat, 09 Dec 2006 11:42:14 +0100
parents c3198eea6c3b
children 73e6ca0a03a9
comparison
equal deleted inserted replaced
1095:8188037a9e2a 1096:3d92e648a8db
1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 1 .\" Title: mcabber
2 .de Sh \" Subsection 2 .\" Author: Mikael BERTHE
3 .br 3 .\" Generator: DocBook XSL Stylesheets v1.71.0 <http://docbook.sf.net/>
4 .if t .Sp 4 .\" Date: 12/09/2006
5 .ne 5 5 .\" Manual:
6 .PP 6 .\" Source:
7 \fB\\$1\fR 7 .\"
8 .PP 8 .TH "MCABBER" "1" "12/09/2006" "" ""
9 .. 9 .\" disable hyphenation
10 .de Sp \" Vertical space (when we can't use .PP) 10 .nh
11 .if t .sp .5v 11 .\" disable justification (adjust text to left margin only)
12 .if n .sp 12 .ad l
13 .. 13 .SH "NAME"
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 14 mcabber \- a simple Jabber console client
23 .SH "SYNOPSIS" 15 .SH "SYNOPSIS"
24 16 \fImcabber\fR [ \-f configfile ] [ \-\-help | \-h ]
25
26 mcabber [ \-f configfile ] [ --help | \-h ]
27
28 .SH "DESCRIPTION" 17 .SH "DESCRIPTION"
29 18 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.
30 19 You also need to have an existing Jabber account to use this software, as it cannot (un)register accounts yet.
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\&.
32
33
34 You also need to have an existing Jabber account to use this software, as it cannot (un)register accounts yet\&.
35
36
37 Here are some of the features of mcabber: 20 Here are some of the features of mcabber:
38 21 .TP 3n
22 \(bu
23
24 \fISSL support\fR.
25 .TP 3n
26 \(bu
27
28 \fIMUC support\fR
29 (Multi\-User Chat).
30 .TP 3n
31 \(bu
32
33 \fIPGP support\fR
34 .TP 3n
35 \(bu
36
37 \fIChat States\fR
38 support (typing notifications)
39 .TP 3n
40 \(bu
41
42 \fIHistory logging:\fR
43 If enabled (see the CONFIGURATION FILE section),
44 mcabber
45 can save discussions to history log files.
46 .TP 3n
47 \(bu
48
49 \fICommands completion:\fR
50 If possible,
51 mcabber
52 will try to complete your command line if you hit the Tab key.
53 .TP 3n
54 \(bu
55
56 \fIInput line history:\fR
57 Any message or command entered is in the input line history and can be reused easily.
58 .TP 3n
59 \(bu
60
61 \fIExternal actions:\fR
62 Some events (like receiving a message) can trigger an external action such as a shell script if you enable it in your configuration file. A sample events script ("eventcmd") is provided with
63 mcabber
64 source code, in the contrib directory.
65 .SH "OPTIONS"
66 .PP
67 \-\-help, \-h
68 .RS 3n
69 Quick help usage message
70 .RE
71 .PP
72 \-f configfile
73 .RS 3n
74 Use configuration file
75 \fIconfigfile\fR
76 .RE
77 .SH "WINDOWS/PANES"
78 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.
79 Two status lines surround the log window. The bottom status line is the "main status line" and reflects mcabber general status. The other line is the "chat status line" and shows the status of the currently selected buddy.
80 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.
81 There are several advantages to the two\-mode implementation: first, it allows accurate "unread" message functionality, as described in the next section; without this, merely scrolling to a specific buddy will "read" the new messages of all buddies in\-between. Second, it allows quickly hiding the conversation with a single keystroke. Third, it allows jumping between the few buddies with whom you are conversing with the \fI/roster alternate\fR command described in another section, without having to manually scroll back and forth.
82 .SH "KEYS"
83 Text typing occurs in the \fIinput line\fR; basic operations are supported (left arrow, right arrow, home/end keys, insert, delete, backspace\&...).
84 PageUp and PageDown keys are used to move in the roster.
85 Up and Down arrow keys can be used to move in the input line history; they jump to the previous/next line from the history beginning with the same string (from first column to the cursor column).
86 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.
87 Here is a quick description of the key bindings:
88 .TS
89 tab(:);
90 l l
91 l l
92 l l
93 l l
94 l l
95 l l
96 l l
97 l l
98 l l
99 l l
100 l l
101 l l
102 l l
103 l l
104 l l
105 l l
106 l l
107 l l
108 l l.
109 T{
110 Esc
111 T}:T{
112 Disable chat mode
113 T}
114 T{
115 Ctrl\-d
116 T}:T{
117 Send/terminate a multi\-line message
118 T}
119 T{
120 Ctrl\-p/Ctrl\-n
121 T}:T{
122 Scroll up/down half a screen in the buffer window (chat mode)
123 T}
124 T{
125 Ctrl\-Left
126 T}:T{
127 Move the cursor back to the start of the current or previous word
128 T}
129 T{
130 Ctrl\-Right
131 T}:T{
132 Move the cursor forward to the end of the current or next word
133 T}
134 T{
135 Ctrl\-u
136 T}:T{
137 Delete from beginning of the line to the cursor
138 T}
139 T{
140 Ctrl\-k
141 T}:T{
142 Delete from the cursor to the end of line
143 T}
144 T{
145 Ctrl\-w
146 T}:T{
147 Backward kill word
148 T}
149 T{
150 Ctrl\-t
151 T}:T{
152 Transpose chars
153 T}
154 T{
155 Ctrl\-o
156 T}:T{
157 Accept line and put the next history line in the input line (accept\-line\-and\-down\-history)
158 T}
159 T{
160 Ctrl\-q
161 T}:T{
162 Jump to the next unread message
163 T}
164 T{
165 Ctrl\-a
166 T}:T{
167 Go to the beginning of the input line
168 T}
169 T{
170 Ctrl\-e
171 T}:T{
172 Go to the end of the input line
173 T}
174 T{
175 Ctrl\-l
176 T}:T{
177 Force a refresh
178 T}
179 T{
180 Up/Down
181 T}:T{
182 Move in the input line history
183 T}
184 T{
185 PgUp/PgDown
186 T}:T{
187 Move inside the roster (buddylist)
188 T}
189 T{
190 Tab
191 T}:T{
192 Complete current word, in the input line
193 T}
194 T{
195 Ctrl\-g
196 T}:T{
197 Cancel completion
198 T}
199 T{
200 Ctrl\-c
201 T}:T{
202 Abort multi\-line messages and completions
203 T}
204 .TE
205
206 Additional key bindings may be specified using the \fI/bind\fR command described in the COMMANDS section.
207 .SH "MCABBER'S ROSTER"
208 The first listed resource on the roster is \fI[status]\fR, which keeps a log of everything that appears in the short log window below the main chat area. While the log window was designed for showing the latest few elements, the dedicated \fI[status]\fR buffer allows more comfortable viewing of the log, as well as scrolling it in a standard manner.
209 Group names are displayed above the resources that are within them, and are indicated by \fI\-\-\-\fR to the left of the name.
210 For every real Jabber resource, the roster displays four pieces of information: the resource's name or alias, its online status, its authorization status, and whether there are unread messages from the resource waiting for you.
211 The online status is one of the following:
212 .TS
213 tab(:);
214 l l
215 l l
216 l l
217 l l
218 l l
219 l l
220 l l
221 l l
222 l l
223 l l.
224 T{
225 \fIo\fR
226 T}:T{
227 online
228 T}
229 T{
230 \fIC\fR
231 T}:T{
232 a conference room in which you are participating
233 T}
234 T{
235 \fIf\fR
236 T}:T{
237 free for chat
238 T}
239 T{
240 \fIa\fR
241 T}:T{
242 away
243 T}
244 T{
245 \fIn\fR
246 T}:T{
247 not available (labeled \fIextended away\fR in some clients)
248 T}
249 T{
250 \fId\fR
251 T}:T{
252 do not disturb
253 T}
254 T{
255 \fIi\fR
256 T}:T{
257 invisible (displayed only for your resource)
258 T}
259 T{
260 \fI_\fR
261 T}:T{
262 offline (or invisible to you)
263 T}
264 T{
265 \fI?\fR
266 T}:T{
267 unknown, usually meaning you are not authorized to see this resource's status
268 T}
269 T{
270 \fIx\fR
271 T}:T{
272 a conference room in which you are not participating
273 T}
274 .TE
275
276 The authorization status indicates whether a resource is authorized to receive your online status updates, and is displayed by the brackets surrounding the resource's online status. Square brackets, like \fI[o]\fR, indicate that this resource is authorized to receive your status. Curly braces, like \fI{o}\fR, indicate that they are not authorized to receive your status.
277 When there are unread messages from the resource which you have not looked at, a hash mark (\fI#\fR) appears in the leftmost section of the roster for that resource. The hash mark disappears once you view that resource's message log.
278 Examples:
279 .TS
280 tab(:);
281 l l
282 l l
283 l l
284 l l
285 l l.
286 T{
287 \fI \-\-\- Buds\fR
288 T}:T{
289 This is a group named \fIBuds\fR
290 T}
291 T{
292 \fI#[o] John\fR
293 T}:T{
294 John is online, can see your status, and sent you a message that you did not read yet
295 T}
296 T{
297 \fI {?} Sally\fR
298 T}:T{
299 Neither you nor Sally have authorized each other to see your online status
300 T}
301 T{
302 \fI {a} Jane\fR
303 T}:T{
304 Jane is away, but she cannot see your online status
305 T}
306 T{
307 \fI#[C] x@y.c\fR
308 T}:T{
309 You are participating in x@y.c conference room, and there are unread messages
310 T}
311 .TE
312
313 .SH "COMMANDS RELATED TO MCABBER"
314 .PP
315 /alias [name [= command line]]
316 .RS 3n
317 Add "name" as an alias for "command line". Aliases are expanded only once, thus they can not be chained. "/alias name" displays the value associated with the "name" alias; "/alias name =" unsets the "name" alias. "/alias" displays a list of the existing aliases. Example: "/alias away = status away".
318 .RE
319 .PP
320 /bind [keycode [= command line]]
321 .RS 3n
322 Bind a command line to the key with the "keycode" code number. Keycodes of unused keys are displayed by
323 mcabber
324 in the log window when pressing the key, for example "Unknown key=265". "/bind keycode" displays the command line bound to the given keycode; "/bind keycode =" unbinds the given keycode. "/bind" displays a list of the bound keycodes. Note: aliases can be used in key bindings. Example: "/bind 265 = status online" (265 is F1 for me, but it may depend on your ncurses installation).
325 .RE
326 .PP
327 /buffer clear|purge|top|bottom|date|%|search_backward|search_forward, /buffer scroll_lock|scroll_unlock|scroll_toggle
328 .RS 3n
329 The
330 \fIbuffer\fR
331 command manipulates the current buddy's buffer (chat window).
332 .TS
333 tab(:);
334 l l
335 l l
336 l l
337 l l
338 l l
339 l l
340 l l
341 l l
342 l l
343 l l
344 l l
345 l l
346 l l.
347 T{
348 \fIclear\fR
349 T}:T{
350 clear the current buddy chat window
351 T}
352 T{
353 \fIsearch_forward\fR
354 text
355 T}:T{
356 search for "text" in the current buddy chat buffer
357 T}
358 T{
359 \fIscroll_lock\fR
360 T}:T{
361 lock buffer scrolling
362 T}
363 T{
364 \fIscroll_unlock\fR
365 T}:T{
366 unlock buffer scrolling
367 T}
368 T{
369 \fIscroll_toggle\fR
370 T}:T{
371 toggle buffer scrolling (lock/unlock)
372 T}
373 T{
374 \fIpurge\fR
375 T}:T{
376 clear the current buddy chat window and empty all contents of the chat buffer
377 T}
378 T{
379 \fIbottom\fR
380 T}:T{
381 jump to the bottom of the current buddy chat buffer
382 T}
383 T{
384 \fItop\fR
385 T}:T{
386 jump to the top of the current buddy chat buffer
387 T}
388 T{
389 \fIup\fR
390 [n]
391 T}:T{
392 scroll the buffer up n lines (default: half a screen)
393 T}
394 T{
395 \fIdown\fR
396 [n]
397 T}:T{
398 scroll the buffer down n lines (default: half a screen)
399 T}
400 T{
401 \fIdate\fR
402 date
403 T}:T{
404 jump to the first line after the specified date in the chat buffer (date format: "YYYY\-mm\-dd[THH:MM:SS]", "\-" and ":" are optional)
405 T}
406 T{
407 \fI%\fR
408 n
409 T}:T{
410 jump to position %n of the buddy chat buffer
411 T}
412 T{
413 \fIsearch_backward\fR
414 text
415 T}:T{
416 search for "text" in the current buddy chat buffer
417 T}
418 .TE
419
420 .RE
421 .PP
422 /clear
423 .RS 3n
424 The
425 \fIclear\fR
426 command is actually an alias for "/buffer clear".
427 .RE
428 .PP
429 /help [command]
430 .RS 3n
431 Display generic help or help about a specific mcabber command.
432 .RE
433 .PP
434 /quit
435 .RS 3n
436 Disconnect and leave
437 mcabber(1).
438 .RE
439 .PP
440 /version
441 .RS 3n
442 Display mcabber version
443 .RE
444 .SH "COMMANDS RELATED TO THE SERVER AND CONNECTION"
445 .PP
446 /connect
447 .RS 3n
448 Establish connection to the Jabber server.
449 .RE
450 .PP
451 /disconnect
452 .RS 3n
453 Terminate connection to the Jabber server. Note: the roster is only available when the connection to the server is active, so the buddylist is empty when disconnected.
454 .RE
455 .PP
456 /event #n|* accept|ignore|reject, /event list
457 .RS 3n
458 Tell mcabber what to do about a pending event. If the first parameter is "*", the command will apply to all queued events.
459 .TS
460 tab(:);
461 l l
462 l l
463 l l
464 l l.
465 T{
466 \fIaccept\fR
467 T}:T{
468 accept the event #n
469 T}
470 T{
471 \fIignore\fR
472 T}:T{
473 remove the event #n from the list
474 T}
475 T{
476 \fIreject\fR
477 T}:T{
478 reject the event #n
479 T}
480 T{
481 \fIlist\fR
482 T}:T{
483 list all pending events
484 T}
485 .TE
486
487 .RE
488 .PP
489 /rawxml send string
490 .RS 3n
491
492 \fIsend\fR
493 string: send string (raw XML format) to the Jabber server. No check is done on the string provided. BEWARE! Use this only if you know what you are doing, or you could terminate the connection.
494 .RE
495 .SH "COMMANDS RELATED TO THE ROSTER AND JABBER RESOURCES"
496 .PP
497 /add [jid [nickname]]
498 .RS 3n
499 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. If no jid (or an empty string "") is provided or if jid is ".", the current buddy is used.
500 .RE
501 .PP
502 /authorization allow|cancel|request|request_unsubscribe [jid]
503 .RS 3n
504 Manage the presence subscriptions. If no jid is provided, the current buddy is used.
505 .TS
506 tab(:);
507 l l
508 l l
509 l l
510 l l.
511 T{
512 \fIallow\fR
513 T}:T{
514 allow the buddy to receive your presence updates
515 T}
516 T{
517 \fIcancel\fR
518 T}:T{
519 cancel the buddy' subscription to your presence updates
520 T}
521 T{
522 \fIrequest\fR
523 T}:T{
524 request a subscription to the buddy's presence updates
525 T}
526 T{
527 \fIrequest_unsubscribe\fR
528 T}:T{
529 request unsubscription from the buddy's presence updates
530 T}
531 .TE
532
533 .RE
534 .PP
535 /del
536 .RS 3n
537 Delete the current buddy from our roster, unsubscribe from its presence notification and unsubscribe it from ours.
538 .RE
539 .PP
540 /group fold|unfold|toggle
541 .RS 3n
542 The
543 \fIgroup\fR
544 command changes the current group display.
545 .TS
546 tab(:);
547 l l
548 l l
549 l l.
550 T{
551 \fIfold\fR
552 T}:T{
553 fold (shrink) the current group tree in the roster
554 T}
555 T{
556 \fIunfold\fR
557 T}:T{
558 unfold (expand) the current group tree in the roster
559 T}
560 T{
561 \fItoggle\fR
562 T}:T{
563 toggle the state (fold/unfold) of the current tree
564 T}
565 .TE
566
567 .RE
568 .PP
569 /info
570 .RS 3n
571 Display info on the selected entry (user, agent, group\&...). For users, resources are displayed with the status, priority and status message (if available) of each resource.
572 .RE
573 .PP
574 /move [groupname]
575 .RS 3n
576 Move the current buddy to the requested group. If no group is specified, then the buddy is moved to the default group. If the group groupname doesn't exist, it is created. Tip: if the chatmode is enabled, you can use "/roster alternate" to jump to the moved buddy.
577 .RE
578 .PP
579 /msay begin|verbatim|send|send_to|toggle|toggle_verbatim|abort
580 .RS 3n
581 Send a multi\-line message. To write a single message with several lines, the
582 \fImulti\-line mode\fR
583 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 (or Ctrl\-d). The
584 \fIbegin\fR
585 subcommand enables multi\-line mode. Note that it allows a message subject to be specified. The
586 \fIverbatim\fR
587 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. The
588 \fItoggle\fR
589 and
590 \fItoggle_verbatim\fR
591 subcommands can be bound to a key to use the multi\-line mode quickly (for example, "bind M109 = msay toggle" to switch using the Meta\-m combination).
592 .TS
593 tab(:);
594 l l
595 l l
596 l l
597 l l
598 l l
599 l l
600 l l.
601 T{
602 \fIbegin\fR
603 [subject]
604 T}:T{
605 enter multi\-line mode
606 T}
607 T{
608 \fIverbatim\fR
609 T}:T{
610 enter verbatim multi\-line mode
611 T}
612 T{
613 \fIsend\fR
614 T}:T{
615 send the current multi\-line message to the currently selected buddy
616 T}
617 T{
618 \fIsend_to\fR
619 jid
620 T}:T{
621 send the current multi\-line message to "jid"
622 T}
623 T{
624 \fItoggle\fR
625 T}:T{
626 switch to/from multi\-line mode (begin/send)
627 T}
628 T{
629 \fItoggle_verbatim\fR
630 T}:T{
631 same with verbatim multi\-line mode
632 T}
633 T{
634 \fIabort\fR
635 T}:T{
636 leave multi\-line mode without sending the message
637 T}
638 .TE
639
640 .RE
641 .PP
642 /pgp disable|enable|info [jid], /pgp setkey [jid [key]]
643 .RS 3n
644 Manipulate PGP settings for the specified jid (by default the currently selected contact). Please note that PGP encryption won't be used if no remote PGP support is detected, even if PGP is enabled with this command.
645 .TS
646 tab(:);
647 l l
648 l l
649 l l
650 l l.
651 T{
652 \fIdisable\fR
653 [jid]
654 T}:T{
655 disable PGP encryption for jid (or the currently selected contact)
656 T}
657 T{
658 \fIenable\fR
659 [jid]
660 T}:T{
661 enable PGP encryption for jid (or the currently selected contact)
662 T}
663 T{
664 \fIinfo\fR
665 [jid]
666 T}:T{
667 show current PGP settings for the contact
668 T}
669 T{
670 \fIsetkey\fR
671 [jid [key]]
672 T}:T{
673 set the PGP key to be used to encrypt message for this contact. If no key is provided, the current key is erased. You can use the shortcut\-jid "." for the currently selected contact.
674 T}
675 .TE
676
677 .RE
678 .PP
679 /rename name
680 .RS 3n
681 Rename current buddy or group to the given name. Please note that a group name change is only done when the server's acknowledgment is received, so a slight delay can be noticed.
682 .RE
683 .PP
684 /request last|time|vcard|version [jid]
685 .RS 3n
686 Send a "IQ" query to the current buddy, or to the specified Jabber user. If the resource is not provided with the jid, mcabber will send the query to all known resources for this user.
687 .RE
688 .PP
689 /room join|leave|names|nick|privmsg|remove|topic|unlock|destroy, /room invite|kick|ban|role|affil, /room bookmark [add|del] [\-autojoin|+autojoin]
690 .RS 3n
691 The
692 \fIroom\fR
693 command handles Multi\-User Chat room actions.
694 .TS
695 tab(:);
696 l l
697 l l
698 l l
699 l l
700 l l
701 l l
702 l l
703 l l
704 l l
705 l l
706 l l
707 l l
708 l l
709 l l
710 l l.
711 T{
712 \fIjoin\fR
713 [room [nick [pass]]]
714 T}:T{
715 join "room", using "nick" as nickname. If no nickname is provided (or if it is an empty string), the "nickname" option value is used (see sample configuration file). If the currently selected entry is correctly recognized as a room by mcabber, the shortcut "." can be used instead of the full room id. A password can be provided to enter protected rooms. If your nickname contains space characters, use quotes.
716 T}
717 T{
718 \fIwhois\fR
719 nick
720 T}:T{
721 display MUC information about "nick"
722 T}
723 T{
724 \fIban\fR
725 jid [reason]
726 T}:T{
727 ban jid from the current room
728 T}
729 T{
730 \fIinvite\fR
731 jid [reason]
732 T}:T{
733 invite jid to the current room
734 T}
735 T{
736 \fIkick\fR
737 nick [reason]
738 T}:T{
739 kick "nick" from the current room
740 T}
741 T{
742 \fIrole\fR
743 jid role [reason]
744 T}:T{
745 change jid's role (role can be "none", "visitor", "participant", "moderator")
746 T}
747 T{
748 \fIaffil\fR
749 jid affil [reason]
750 T}:T{
751 change jid's affiliation (affil can be "none", "member", "admin", "owner")
752 \fIbookmark\fR
753 add/update/remove a room bookmark, set/unset autojoin
754 T}
755 T{
756 \fIleave\fR
757 [message]
758 T}:T{
759 leave the current room
760 T}
761 T{
762 \fInames\fR
763 T}:T{
764 display members of the current room
765 T}
766 T{
767 \fInick\fR
768 nick
769 T}:T{
770 change your nickname in the current room
771 T}
772 T{
773 \fIprivmsg\fR
774 nick msg
775 T}:T{
776 send private message "msg" to "nick"
777 T}
778 T{
779 \fIremove\fR
780 T}:T{
781 remove the current room from the roster (you must have left this room before)
782 T}
783 T{
784 \fItopic\fR
785 T}:T{
786 set topic for current room
787 T}
788 T{
789 \fIunlock\fR
790 T}:T{
791 unlock current room (if you are the owner)
792 T}
793 T{
794 \fIdestroy\fR
795 [reason]
796 T}:T{
797 destroy the current room (use with care!)
798 T}
799 .TE
800
801 .RE
802 .PP
803 /roster bottom|top|up|down|group_prev|group_next, /roster alternate|unread_first|unread_next, /roster search bud, /roster hide_offline|show_offline|toggle_offline, /roster item_lock|item_unlock, /roster hide|show|toggle, /roster note [\-|text]
804 .RS 3n
805 The
806 \fIroster\fR
807 command manipulates the roster/buddylist. Here are the available parameters:
808 .TS
809 tab(:);
810 l l
811 l l
812 l l
813 l l
814 l l
815 l l
816 l l
817 l l
818 l l
819 l l
820 l l
821 l l
822 l l
823 l l
824 l l
825 l l
826 l l
827 l l
828 l l.
829 T{
830 \fIbottom\fR
831 T}:T{
832 jump to the bottom of the roster
833 T}
834 T{
835 \fIsearch\fR
836 bud
837 T}:T{
838 search for a buddy with a name or jid containing "bud" (only in the displayed buddylist)
839 T}
840 T{
841 \fIhide_offline\fR
842 T}:T{
843 hide offline buddies
844 T}
845 T{
846 \fIshow_offline\fR
847 T}:T{
848 show offline buddies
849 T}
850 T{
851 \fItoggle_offline\fR
852 T}:T{
853 toggle display of offline buddies
854 T}
855 T{
856 \fIitem_lock\fR
857 jid
858 T}:T{
859 lock the roster item so it remains visible regardless of its status
860 T}
861 T{
862 \fIitem_unlock\fR
863 jid
864 T}:T{
865 undo the effects of item_lock
866 T}
867 T{
868 \fIhide\fR
869 T}:T{
870 hide roster (full\-width chat window)
871 T}
872 T{
873 \fIshow\fR
874 T}:T{
875 show roster
876 T}
877 T{
878 \fItoggle\fR
879 T}:T{
880 toggle roster visibility
881 T}
882 T{
883 \fInote\fR
884 [text]
885 T}:T{
886 display or set an annotation (if text is "\-", the annotation is deleted). In the "status" buffer, it will display all annotations.
887 T}
888 T{
889 \fItop\fR
890 T}:T{
891 jump to the top of the roster
892 T}
893 T{
894 \fIup\fR
895 T}:T{
896 move up in the roster
897 T}
898 T{
899 \fIdown\fR
900 T}:T{
901 move down in the roster
902 T}
903 T{
904 \fIgroup_prev\fR
905 T}:T{
906 jump to the previous group in the roster
907 T}
908 T{
909 \fIgroup_next\fR
910 T}:T{
911 jump to the next group in the roster
912 T}
913 T{
914 \fIalternate\fR
915 T}:T{
916 jump to alternate buddy. The "alternate" buddy is the last buddy left while being in chat mode (this command is thus especially useful after commands like "/roster unread_first")
917 T}
918 T{
919 \fIunread_first\fR
920 T}:T{
921 jump to the first unread message
922 T}
923 T{
924 \fIunread_next\fR
925 T}:T{
926 jump to the next unread message
927 T}
928 .TE
929
930 .RE
931 .PP
932 /say text
933 .RS 3n
934 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.
935 .RE
936 .PP
937 /say_to jid text
938 .RS 3n
939 Send the "text" message to the specified jid. Please note that this command doesn't set the default resource for a contact, so if you want to send several messages to a specific resource you will have to use "/say_to" for each message.
940 .RE
941 .PP
942 /status [online|avail|invisible|free|dnd|notavail|away [\-|StatusMessage]]
943 .RS 3n
944 Show or set the current status. If no status is specified, display the current status. If a status message is specified, it will overrride the message* variables (these variables can be set in the configuration file). If no relevant message* variable is set and no status message provided, the current status message is kept. If StatusMessage is "\-", the current status message is cleared.
945 .RE
946 .PP
947 /status_to jid online|avail|invisible|free|dnd|notavail|away [StatusMessage]
948 .RS 3n
949 Send the requested status to the specified Jabber user. If the specified jid is ".", the current buddy is used. Note: this status will be overridden by subsequent "/status" commands. If you are using the auto\-away feature, the status will overridden too. Note: The jid can include a resource (i.e. user@server/resource).
950 .RE
951 .SH "CONFIGURATION FILE"
952 See the provided sample configuration file, which should be self\-documenting.
953 .SH "FILES"
954 The following files can be used by mcabber(1):
955
956 .RS 3n
957 .nf
958 $HOME/.mcabber/mcabberrc Default configuration file
959 $HOME/.mcabberrc Configuration file used if no other has been found
960 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled
961 .fi
962 .RE
963 .SH "BUGS"
964 Certainly. Please tell me if you find one! :\-)
965 .SH "AUTHOR"
966 Written by [1]\&\fIMikael BERTHE\fR. Originally based on [2]\&\fICabber\fR, please consult the AUTHORS file for details.
967 .SH "RESOURCES"
968 [3]\&\fIMain web site\fR
969 .SH "COPYING"
970 Copyright (C) 2005, 2006 Mikael Berthe. Some portions are Copyright (C) 2002\-2004 [4]\&\fIcabber@ajmacias.com\fR.
971 Free use of this software is granted under the terms of the GNU General Public License (GPL).
972 .SH "REFERENCES"
39 .TP 3 973 .TP 3
40 \(bu 974 1.\ Mikael BERTHE
41 SSL support\&. 975 \%mailto:mcabber@lilotux.net
42 .TP 976 .TP 3
43 \(bu 977 2.\ Cabber
44 MUC support (Multi\-User Chat)\&. 978 \%http://cabber.sourceforge.net
45 .TP 979 .TP 3
46 \(bu 980 3.\ Main web site
47 History logging: If enabled (see the CONFIGURATION FILE section), mcabber can save discussions to history log files\&. 981 \%http://www.lilotux.net/~mikael/mcabber/
48 .TP 982 .TP 3
49 \(bu 983 4.\ cabber@ajmacias.com
50 Commands completion: If possible, mcabber will try to complete your command line if you hit the Tab key\&. 984 \%mailto:cabber@ajmacias.com
51 .TP
52 \(bu
53 Input line history: Any message or command entered is in the input line history and can be reused easily\&.
54 .TP
55 \(bu
56 External actions: Some events (like receiving a message) can trigger an external action such as a shell script if you enable it in your configuration file\&. A sample events script ("eventcmd") is provided with mcabber source code, in the contrib directory\&.
57 .LP
58
59 .SH "OPTIONS"
60
61 .TP
62 \-\-help, \-h
63 Quick help usage message
64
65 .TP
66 \-f configfile
67 Use configuration file configfile
68
69 .SH "WINDOWS/PANES"
70
71
72 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\&.
73
74
75 Two status lines surround the log window\&. The bottom status line is the "main status line" and reflects mcabber general status\&. The other line is the "chat status line" and shows the status of the currently selected buddy\&.
76
77
78 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\&.
79
80
81 There are several advantages to the two\-mode implementation: first, it allows accurate "unread" message functionality, as described in the next section; without this, merely scrolling to a specific buddy will "read" the new messages of all buddies in\-between\&. Second, it allows quickly hiding the conversation with a single keystroke\&. Third, it allows jumping between the few buddies with whom you are conversing with the \fI/roster alternate\fR command described in another section, without having to manually scroll back and forth\&.
82
83 .SH "KEYS"
84
85
86 Text typing occurs in the \fIinput line\fR; basic operations are supported (left arrow, right arrow, home/end keys, insert, delete, backspace...)\&.
87
88
89 PageUp and PageDown keys are used to move in the roster\&.
90
91
92 Up and Down arrow keys can be used to move in the input line history; they jump to the previous/next line from the history beginning with the same string (from first column to the cursor column)\&.
93
94
95 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\&.
96
97
98 Here is a quick description of the key bindings:
99
100 Ctrl\-a Go to the beginning of the input line
101
102 Ctrl\-e Go to the end of the input line
103
104 Ctrl\-l Force a refresh
105
106 Up/Down Move in the input line history
107
108 PgUp/PgDown Move inside the roster (buddylist)
109
110 Tab Complete current word, in the input line
111
112 Ctrl\-g Cancel completion / ctrl\-g
113
114 Ctrl\-p/Ctrl\-n Scroll up/down half a screen in the buffer window (chat mode)
115
116 Ctrl\-Left Move the cursor back to the start of the current or previous word
117
118 Ctrl\-Right Move the cursor forward to the end of the current or next word
119
120 Ctrl\-u Delete from beginning of the line to the cursor
121
122 Ctrl\-k Delete from the cursor to the end of line
123
124 Ctrl\-w Backward kill word
125
126 Ctrl\-t Transpose chars
127
128 Ctrl\-o Accept line and put the next history line in the input line (accept\-line\-and\-down\-history)
129
130 Ctrl\-q Jump to the next unread message
131
132 Additional key bindings may be specified using the /bind command described
133 in the COMMANDS section\&.
134
135 .SH "MCABBER'S ROSTER"
136
137
138 The first listed resource on the roster is \fI[status]\fR, which keeps a log of everything that appears in the short log window below the main chat area\&. While the log window was designed for showing the latest few elements, the dedicated \fI[status]\fR buffer allows more comfortable viewing of the log, as well as scrolling it in a standard manner\&.
139
140
141 Group names are displayed above the resources that are within them, and are indicated by \fI\-\-\-\fR to the left of the name\&.
142
143
144 For every real Jabber resource, the roster displays four pieces of information: the resource's name or alias, its online status, its authorization status, and whether there are unread messages from the resource waiting for you\&.
145
146
147 The online status is one of the following:
148
149 \fBo\fR online
150 \fBf\fR free for chat
151 \fBa\fR away
152 \fBn\fR not available (labeled \fIextended away\fR in some clients)
153 \fBd\fR do not disturb
154 \fBi\fR invisible (displayed only for your resource)
155 \fB_\fR offline (or invisible to you)
156 \fB?\fR unknown, usually meaning you are not authorized to see this resource's status
157 \fBx\fR a conference room in which you are not participating
158 \fBC\fR a conference room in which you are participating
159
160
161 The authorization status indicates whether a resource is authorized to receive your online status updates, and is displayed by the brackets surrounding the resource's online status\&. Square brackets, like \fI[o]\fR, indicate that this resource is authorized to receive your status\&. Curly braces, like \fI{o}\fR, indicate that they are not authorized to receive your status\&.
162
163
164 When there are unread messages from the resource which you have not looked at, a hash mark (\fI#\fR) appears in the leftmost section of the roster for that resource\&. The hash mark disappears once you view that resource's message log\&.
165
166
167 Examples:
168
169 \fB \-\-\- Buds\fR This is a group named \fIBuds\fR
170 \fB#[o] John\fR John is online, can see your status, and sent you a message that you did not read yet
171 \fB {?} Sally\fR Neither you nor Sally have authorized each other to see your online status
172 \fB {a} Jane\fR Jane is away, but she cannot see your online status
173 \fB#[C] x@y\&.c\fR You are participating in x@y\&.c conference room, and there are unread messages
174
175
176 .SH "COMMANDS RELATED TO MCABBER"
177
178 .TP
179 \fB/alias\fR [name [= command line]]
180 Add "name" as an alias for "command line"\&.
181
182 Aliases are expanded only once, thus they can not be chained\&.
183
184 "/alias name" displays the value associated with the "name" alias; "/alias name =" unsets the "name" alias\&.
185 "/alias" displays a list of the existing aliases\&.
186
187 Example: "/alias away = status away"\&.
188
189 .TP
190 \fB/bind\fR [keycode [= command line]]
191 Bind a command line to the key with the "keycode" code number\&.
192
193 Keycodes of unused keys are displayed by mcabber in the log window when pressing the key, for example "Unknown key=265"\&.
194
195 "/bind keycode" displays the command line bound to the given keycode; "/bind keycode =" unbinds the given keycode\&.
196 "/bind" displays a list of the bound keycodes\&.
197
198 Note: aliases can be used in key bindings\&.
199
200 Example: "/bind 265 = status online" (265 is F1 for me, but it may depend on your ncurses installation)\&.
201
202 .TP
203 \fB/buffer\fR clear|top|bottom|date|%|search_backward|search_forward|...
204 The buffer command manipulates the current buddy's buffer (chat window)\&.
205
206 \fBclear\fR clear the current buddy chat window
207 \fBpurge\fR clear the current buddy chat window and empty all contents of the chat buffer
208 \fBbottom\fR jump to the bottom of the current buddy chat buffer
209 \fBtop\fR jump to the top of the current buddy chat buffer
210 \fBup\fR [n] scroll the buffer up n lines (default: half a screen)
211 \fBdown\fR [n] scroll the buffer down n lines (default: half a screen)
212 \fBdate\fR date jump to the first line after the specified date in the chat buffer (date format: "YYYY\-mm\-dd[THH:MM:SS]", "\-" and ":" are optional)
213 \fB%\fR n jump to position %n of the buddy chat buffer
214 \fBsearch_backward\fR text search for "text" in the current buddy chat buffer
215 \fBsearch_forward\fR text search for "text" in the current buddy chat buffer
216 \fBscroll_lock\fR lock buffer scrolling
217 \fBscroll_unlock\fR unlock buffer scrolling
218 \fBscroll_toggle\fR toggle buffer scrolling (lock/unlock)
219
220 .TP
221 \fB/clear\fR
222 The clear command is actually an alias for "/buffer clear"\&.
223
224 .TP
225 \fB/help\fR [command]
226 Display generic help or help about a specific mcabber command\&.
227
228 .TP
229 \fB/quit\fR
230 Disconnect and leave mcabber(1)\&.
231
232 .TP
233 \fB/version\fR
234 Display mcabber version
235
236 .SH "COMMANDS RELATED TO THE SERVER AND CONNECTION"
237
238 .TP
239 \fB/connect\fR
240 Establish connection to the Jabber server\&.
241
242 .TP
243 \fB/disconnect\fR
244 Terminate connection to the Jabber server\&. Note: the roster is only available when the connection to the server is active, so the buddylist is empty when disconnected\&.
245
246 .TP
247 \fB/event\fR #n|* accept|ignore|reject, \fB/event\fR list
248 Tell mcabber what to do about a pending event\&. If the first parameter is "*", the command will apply to all queued events\&.
249
250 \fBaccept\fR accept the event #n
251 \fBignore\fR remove the event #n from the list
252 \fBreject\fR reject the event #n
253 \fBlist\fR list all pending events
254
255 .TP
256 \fB/rawxml\fR send string
257 \fBsend\fR string: send string (raw XML format) to the Jabber server\&. No check is done on the string provided\&. BEWARE! Use this only if you know what you are doing, or you could terminate the connection\&.
258
259 .SH "COMMANDS RELATED TO THE ROSTER AND JABBER RESOURCES"
260
261 .TP
262 \fB/add\fR [jid [nickname]]
263 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\&. If no jid (or an empty string "") is provided or if jid is "\&.", the current buddy is used\&.
264
265 .TP
266 \fB/authorization\fR allow|cancel|request|request_unsubscribe [jid]
267 Manage the presence subscriptions\&.
268
269 If no jid is provided, the current buddy is used\&.
270
271 \fBallow\fR allow the buddy to receive your presence updates
272 \fBcancel\fR cancel the buddy' subscription to your presence updates
273 \fBrequest\fR request a subscription to the buddy's presence updates
274 \fBrequest_unsubscribe\fR request unsubscription from the buddy's presence updates
275
276 .TP
277 \fB/del\fR
278 Delete the current buddy from our roster, unsubscribe from its presence notification and unsubscribe it from ours\&.
279
280 .TP
281 \fB/group\fR fold|unfold|toggle
282 The group command changes the current group display\&.
283
284 \fBfold\fR fold (shrink) the current group tree in the roster
285 \fBunfold\fR unfold (expand) the current group tree in the roster
286 \fBtoggle\fR toggle the state (fold/unfold) of the current tree
287
288 .TP
289 \fB/info\fR
290 Display info on the selected entry (user, agent, group...)\&. For users, resources are displayed with the status, priority and status message (if available) of each resource\&.
291
292 .TP
293 \fB/move\fR [groupname]
294 Move the current buddy to the requested group\&. If no group is specified, then the buddy is moved to the default group\&. If the group groupname doesn't exist, it is created\&. Tip: if the chatmode is enabled, you can use "/roster alternate" to jump to the moved buddy\&.
295
296 .TP
297 \fB/msay\fR begin|verbatim|send|send_to|toggle|toggle_verbatim|abort
298 Send a multi\-line message\&. To write a single message with several lines, the \fImulti\-line mode\fR should be used\&.
299
300 The \fIbegin\fR subcommand enables multi\-line mode\&. Note that it allows a message subject to be specified\&.
301
302 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\&.
303
304 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\&.
305
306 The \fItoggle\fR and \fItoggle_verbatim\fR subcommands can be bound to a key to use the multi\-line mode quickly (for example, "bind M109 = msay toggle" to switch using the Meta\-m combination)\&.
307
308 \fBbegin\fR [subject] enter multi\-line mode
309 \fBverbatim\fR enter verbatim multi\-line mode
310 \fBsend\fR send the current multi\-line message to the currently selected buddy
311 \fBsend_to\fR jid send the current multi\-line message to "jid"
312 \fBtoggle\fR switch to/from multi\-line mode (begin/send)
313 \fBtoggle_verbatim\fR same with verbatim multi\-line mode
314 \fBabort\fR leave multi\-line mode without sending the message
315
316 .TP
317 \fB/rename\fR name
318 Rename current buddy or group to the given name\&. Please note that a group name change is only done when the server's acknowledgment is received, so a slight delay can be noticed\&.
319
320 .TP
321 \fB/request\fR time|version [jid]
322 Send a "IQ" query to the current buddy, or to the specified Jabber user\&. If the resource is not provided with the jid, mcabber will send the query to all known resources for this user\&.
323
324 .TP
325 \fB/room\fR
326 The room command handles Multi\-User Chat room actions\&.
327
328 \fBjoin\fR [room [nick [pass]]] join "room", using "nick" as nickname\&. If no nickname is provided (or if it is an empty string), the "nickname" option value is used (see sample configuration file)\&. If the currently selected entry is correctly recognized as a room by mcabber, the shortcut "\&." can be used instead of the full room id\&. A password can be provided to enter protected rooms\&. If your nickname contains space characters, use quotes\&.
329 \fBleave\fR [message] leave the current room
330 \fBnames\fR display members of the current room
331 \fBnick\fR nick change your nickname in the current room
332 \fBprivmsg\fR nick msg send private message "msg" to "nick"
333 \fBremove\fR remove the current room from the roster (you must have left this room before)
334 \fBtopic\fR set topic for current room
335 \fBunlock\fR unlock current room (if you are the owner)
336 \fBdestroy\fR [reason] destroy the current room (use with care!)
337 \fBwhois\fR nick display MUC information about "nick"
338
339 \fBinvite\fR jid [reason] invite jid to the current room
340 \fBkick\fR nick [reason] kick "nick" from the current room
341 \fBban\fR jid [reason] ban jid from the current room
342 \fBrole\fR jid role [reason] change jid's role (role can be "none", "visitor", "participant", "moderator")
343 \fBaffil\fR jid affil [reason] change jid's affiliation (affil can be "none", "member", "admin", "owner")
344
345 .TP
346 \fB/roster\fR
347 The roster command manipulates the roster/buddylist\&. Here are the available parameters:
348
349 \fBbottom\fR jump to the bottom of the roster
350 \fBtop\fR jump to the top of the roster
351 \fBup\fR move up in the roster
352 \fBdown\fR move down in the roster
353 \fBhide_offline\fR hide offline buddies
354 \fBshow_offline\fR show offline buddies
355 \fBtoggle_offline\fR toggle display of offline buddies
356 \fBhide\fR hide roster (full\-width chat window)
357 \fBshow\fR show roster
358 \fBtoggle\fR toggle roster visibility
359 \fBitem_lock\fR jid lock the roster item so it remains visible regardless of its status
360 \fBitem_unlock\fR jid undo the effects of item_lock
361 \fBsearch\fR bud search for a buddy with a name or jid containing "bud" (only in the displayed buddylist)
362 \fBalternate\fR jump to alternate buddy\&. The "alternate" buddy is the last buddy left while being in chat mode (this command is thus especially useful after commands like "/roster unread_first")
363 \fBunread_first\fR jump to the first unread message
364 \fBunread_next\fR jump to the next unread message
365
366 .TP
367 \fB/say\fR text
368 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\&.
369
370 .TP
371 \fB/say_to\fR jid text
372 Send the "text" message to the specified jid\&. Please note that this command doesn't set the default resource for a contact, so if you want to send several messages to a specific resource you will have to use "/say_to" for each message\&.
373
374 .TP
375 \fB/status\fR [online|avail|invisible|free|dnd|notavail|away [\-|StatusMessage]]
376 Show or set the current status\&.
377
378 If no status is specified, display the current status\&.
379
380 If a status message is specified, it will overrride the message* variables (these variables can be set in the configuration file)\&. If no relevant message* variable is set and no status message provided, the current status message is kept\&. If StatusMessage is "\-", the current status message is cleared\&.
381
382 .TP
383 \fB/status_to\fR jid online|avail|invisible|free|dnd|notavail|away [StatusMessage]
384 Send the requested status to the specified Jabber user\&.
385
386 If the specified jid is "\&.", the current buddy is used\&.
387
388 Note: this status will be overridden by subsequent "/status" commands\&. If you are using the auto\-away feature, the status will overridden too\&.
389
390 Note: The jid can include a resource (i\&.e\&. user@server/resource)\&.
391
392 .SH "CONFIGURATION FILE"
393
394
395 See the provided sample configuration file, which should be self\-documenting\&.
396
397 .SH "FILES"
398
399
400 The following files can be used by mcabber(1):
401
402 .nf
403 $HOME/\&.mcabber/mcabberrc Default configuration file
404 $HOME/\&.mcabberrc Configuration file used if no other has been found
405 $HOME/\&.mcabber/histo/ Default directory for storing chat history files, if enabled
406 .fi
407
408 .SH "BUGS"
409
410
411 Certainly\&. Please tell me if you find one! :\-)
412
413 .SH "AUTHOR"
414
415
416 Written by Mikael BERTHE <\fImcabber@lilotux.net\fR>\&.
417 Originally based on cabber (Cabber homepage: <\fIhttp://cabber.sourceforge.net\fR>), please consult the AUTHORS file for details\&.
418
419 .SH "RESOURCES"
420
421
422 Main web site: <\fIhttp://www.lilotux.net/~mikael/mcabber/\fR>
423
424 .SH "COPYING"
425
426
427 Copyright (C) 2005, 2006 Mikael Berthe\&.
428
429 Some portions are Copyright (C) 2002\-2004 <cabber@ajmacias\&.com>\&.
430
431
432 Free use of this software is granted under the terms of the GNU General Public License (GPL)\&.
433