1MCABBER(1) MCABBER(1)
2
6 mcabber - a simple Jabber (XMPP) console client
7
9 mcabber [ -h | -V | -f configfile ]
10
12 mcabber(1) is a small Jabber (XMPP) console client. For now it needs a
13 configuration file to start, so please copy the sample mcabberrc file
14 and adapt your connection settings.
15 You also need to have an existing Jabber account to use this software,
17 as it cannot (un)register accounts yet.
18 Here are some of the features of mcabber:
20 · SASL/SSL/TLS support.
22 · MUC support (Multi-User Chat).
24 · PGP, OTR support
26 · Chat States support (typing notifications)
28 · History logging: If enabled (see the CONFIGURATION FILE section),
30 mcabber can save discussions to text history log files.
31 · Commands completion: If possible, mcabber will try to complete your
33 command line if you hit the Tab key.
34 · Input line history: Any message or command entered is in the input
36 line history and can be reused easily.
37 · External actions: Some events (like receiving a message) can
39 trigger an external action such as a shell script if you enable it
40 in your configuration file. A sample events script ("eventcmd") is
41 provided with mcabber source code, in the contrib directory.
42 · Modules:mcabber can load modules (a.k.a. plugins) at runtime that
44 extend its features.
45
47 -h
48 Quick help usage message
49 -V
51 Displays mcabber version and compile-time definitions.
52 -f configfile
54 Use configuration file configfile
55
57 The mcabber(1) screen is divided into 4 regions. The roster, alias
58 buddylist, is on the left. The chat window, or chat buffer, is on the
59 right. The input line lies at the bottom of the screen, under a small
60 log window.
61 Two status lines surround the log window. The bottom status line is the
63 "main status line" and reflects mcabber general status. The other line
64 is the "chat status line" and shows the status of the currently
65 selected buddy.
66 To display buddies chat buffers, you will have to enter chat mode. You
68 can enter chat mode by pressing enter (unless vi mode is enabled), and
69 leave chat mode with the ESC key. Simply sending a message will also
70 enable chat mode (unless vi mode is enabled).
71 There are several advantages to the two-mode implementation: first, it
73 allows accurate "unread" message functionality, as described in the
74 next section; without this, merely scrolling to a specific buddy will
75 "read" the new messages of all buddies in-between. Second, it allows
76 quickly hiding the conversation with a single keystroke. Third, it
77 allows jumping between the few buddies with whom you are conversing
78 with the /roster alternate command described in another section,
79 without having to manually scroll back and forth.
80
82 Text typing occurs in the input line; basic operations are supported
83 (left arrow, right arrow, home/end keys, insert, delete, backspace...).
84 PageUp and PageDown keys are used to move in the roster.
86 Up and Down arrow keys can be used to move in the input line history;
88 they jump to the previous/next line from the history beginning with the
89 same string (from first column to the cursor column).
90 To send a message, move to the chosen buddy in the buddylist, type your
92 message and hit enter. If the line begins with a slash, this will be
93 interpreted as a command (see the COMMAND section below). Hit escape to
94 leave the chat mode.
95 Here is a quick description of the default key bindings:
97 Esc
99 Disable chat mode
100 Ctrl-a
102 Go to the beginning of the input line
103 Ctrl-e
105 Go to the end of the input line
106 Ctrl-l
108 Force a refresh
109 Up/Down
111 Move in the input line history
112 PgUp/PgDown
114 Move inside the roster (buddylist)
115 Tab
117 Complete current word, in the input line
118 Ctrl-g
120 Cancel completion
121 Ctrl-c
123 Abort multi-line messages and completions
124 Ctrl-d
126 Send/terminate a multi-line message
127 Ctrl-p/Ctrl-n
129 Scroll up/down half a screen in the buffer window (chat mode)
130 Ctrl-Left
132 Move the cursor back to the start of the current or previous word
133 Ctrl-Right
135 Move the cursor forward to the end of the current or next word
136 Ctrl-u
138 Delete from beginning of the line to the cursor
139 Ctrl-k
141 Delete from the cursor to the end of line
142 Ctrl-w
144 Backward kill word
145 Ctrl-t
147 Transpose chars
148 Ctrl-o
150 Accept line and put the next history line in the input line
151 (accept-line-and-down-history)
152 Additional key bindings may be specified using the /bind command
154 described in the COMMANDS section.
155
157 If the "vi_mode" option is set to 1, mcabber(1) accepts a few commands
158 loosely based on those available in vi(1)'s normal mode. In this case,
159 chat mode is not entered by pressing enter, and messages cannot be
160 composed outside of the chat mode. The following commands are accepted:
161 A
163 Call "/roster unread_first".
164 a
166 Call "/roster unread_next".
167 F
169 Call "/roster group_prev".
170 f
172 Call "/roster group_next".
173 G
175 Call "/roster bottom".
176 gg
178 Call "/roster top".
179 i
181 Enter chat mode.
182 [N]j
184 Call "/roster down [N]".
185 [N]k
187 Call "/roster up [N]".
188 n
190 Repeat the previous search (if any).
191 O
193 Call "/roster unread_first" and open chat window.
194 o
196 Call "/roster unread_next" and open chat window.
197 ZZ
199 Call "/quit".
200 zM
202 Call "/group fold" for all groups.
203 zR
205 Call "/group unfold" for all groups.
206 ''
208 Call "/roster alternate".
209 !
211 Toggle attention flag for current buddy.
212 #
214 Toggle unread messages flag for current buddy.
215 <Space>
217 Call "/group toggle" for the current group.
218 A leading slash enables search mode:
220 /string
222 Call "/roster search string".
223 A leading colon enabled command-line mode:
225 above commands).
227 Commands entered with a leading colon and searches are either submitted
229 by pressing enter or aborted by hitting escape. In either case,
230 mcabber(1) returns to the normal (non-chat) mode. History editing is
231 supported in command-line mode and in search mode. In command-line
232 mode, tab completion is supported as well.
233
235 The first listed item on the roster is [status], which keeps a log of
236 everything that appears in the short log window below the main chat
237 area. While the log window was designed for showing the latest few
238 elements, the dedicated [status] buffer allows more comfortable viewing
239 of the log, as well as scrolling it in a standard manner.
240 Group names are displayed above the items that are within them, and are
242 indicated by --- to the left of the name.
243 For every real Jabber contact, the roster displays four pieces of
245 information: the buddy’s name or alias, its online status, its
246 authorization status, and whether there are unread messages from the
247 buddy waiting for you.
248 The online status is one of the following:
250 o
252 online
253 f
255 free for chat
256 a
258 away
259 n
261 not available (labeled extended away in some clients)
262 d
264 do not disturb
265 _
267 offline (or invisible to you)
268 ?
270 unknown, usually meaning you are not authorized to see this buddy’s
271 status
272 x
274 a conference room in which you are not participating
275 C
277 a conference room in which you are participating
278 The authorization status indicates whether a buddy is authorized to
280 receive your online status updates, and is displayed by the brackets
281 surrounding the buddy’s online status. Square brackets, like [o],
282 indicate that this buddy is authorized to receive your status. Curly
283 braces, like {o}, indicate that they are not authorized to receive your
284 status.
285 When there are unread messages from a buddy which you have not looked
287 at, a hash mark (#) appears in the leftmost section of the roster for
288 that buddy. The hash mark disappears once you view that buddy’s message
289 buffer. When the user attention is requested (or when you receive a
290 message containing your nickname in a MUC room), the hash mark is
291 replaced with the attention sign, an exclamation mark (!).
292 Examples:
294 ' --- Buds'
296 This is a group named Buds
297 #[o] John
299 John is online, can see your status, and sent you a message that
300 you did not read yet
301 ' {?} Sally'
303 Neither you nor Sally have authorized each other to see your online
304 status
305 ' {a} Jane'
307 Jane is away, but she cannot see your online status
308 #[C] x@y.c
310 You are participating in x@y.c conference room, and there are
311 unread messages
312
314 Please refer to the online help (command /help), it is probably more
315 up-to-date than this manpage. Furthermore, help files have been
316 translated into several languages. You will find an overview of the
317 mcabber commands in this manual.
318
320 /add [jid [nickname]]
321 Add the "jid" Jabber user to our roster (default group), and send a
322 notification request to this buddy. If no nickname is specified,
323 the jid is used. If no jid (or an empty string "") is provided or
324 if jid is ".", the current buddy is used.
325 [jid [nickname]]
327 Add to our roster "jid" as "nickname"
328 Example: "/add somebody@jabber.server.com Somebody"
330 /alias [name [= command line]]
332 This command let you to add aliases which can simplify
333 sophisticated commands.
334 You can manage your aliases by:
336 (without arguments)
338 Print list of currently defined aliases
339 name
341 Print the value of alias called "name"
342 name=
344 Unset alias called "name"
345 name = command line
347 Set alias called "name" with value "command line"
348 Example: "/alias away = status away"
350 /authorization allow|cancel|request|request_unsubscribe [jid]
352 This command manages presence subscriptions: it allows you to
353 request presence subscriptions from others on your roster, and
354 allows you to control who receives your presence notifications.
355 If no JID is provided, the currently-selected buddy is used.
357 allow
359 Allow the buddy to receive your presence updates
360 cancel
362 Cancel the buddy’s subscription to your presence updates
363 request
365 Request a subscription to the buddy’s presence updates
366 request_unsubscribe
368 Request unsubscription from the buddy’s presence updates
369 /bind [keycode [= command line]]
371 Bind the command to the key given as "keycode". To examine which
372 keys are currently not used look at mcabber log window and press
373 examined key. For example: "Unknown key=265" means that you can
374 bind some command to key #265.
375 (without arguments)
377 Display list of current bindings
378 keycode
380 Display the command line bound to this key
381 keycode=
383 Unbind key with code "keycode"
384 keycode = command line
386 Bind "command line" to the key with code "keycode"
387 Example: "/bind 265 = status away" (265 is F1). +
389 Note: keycodes can be different depending on your ncurses configuration. +
390 Tip: aliases also can be used instead of commands.
391 /buffer clear|close|close_all|purge|list, /buffer
393 top|bottom|date|%|search_backward|search_forward, /buffer
394 scroll_lock|scroll_unlock|scroll_toggle, /buffer save filename
395 Buddy’s buffer manipulation command. E.g. you can search through
396 buffer for "text", clear chat window etc.
397 clear
399 Clear the current buddy chat window
400 close [jid]
402 Empty all contents of the buffer and close the current buddy
403 chat window
404 close_all
406 Empty all contents of the chat buffers and close the chat
407 windows
408 purge [jid]
410 Clear the current buddy chat window and empty all contents of
411 the chat buffer
412 list
414 Display the list of existing buffers, with their length
415 (lines/blocks)
416 top
418 Jump to the top of the current buddy chat buffer
419 bottom
421 Jump to the bottom of the current buddy chat buffer
422 up [n]
424 Scroll the buffer up [n] lines (default: half a screen)
425 down [n]
427 Scroll the buffer down [n] lines (default: half a screen)
428 date [date]
430 Jump to the first line after the specified [date] in the chat
431 buffer (date format: "YYYY-mm-dd")
432 % n
434 Jump to position %n of the buddy chat buffer
435 search_backward text
437 Search for [text] in the current buddy chat buffer
438 search_forward text
440 Search for [text] in the current buddy chat buffer
441 scroll_lock
443 Lock buffer scrolling
444 scroll_unlock
446 Unlock buffer scrolling
447 scroll_toggle
449 Toggle buffer scrolling (lock/unlock)
450 save filename
452 Save the contents of the current buffer to the file "filename"
453 /chat_disable [--show-roster]
455 Disable chat mode.
456 With --show-roster, the fullscreen mode will be disabled.
458 /clear
460 This command is actually an alias for "/buffer clear". It clears
461 the current buddy chat window.
462 /color roster (status wildcard (color|-)|clear), /color mucnick nick
464 (color|-), /color muc (jid|.|*) [on|preset|off|-]
465 The color command allows setting dynamic color properties of the
466 screen.
467 roster clear
469 Remove all color rules for the roster. All roster items will
470 get its default color.
471 roster status wildcard color
473 Set a color rule (or overwrite, if it already exists). The
474 status is string containing all statuses the roster item can
475 have for the rule to match, or * if any status is OK. Wildcard
476 is the file-matching wildcard that will be applied to JID.
477 Color is the wanted color. If color is -, the rule is removed.
478 If more than one rule matches, the color from the last created
479 (not overwritten) is used.
480 mucnick nick (color|-)
482 Marks the nick to be colored by given color. If a MUC has
483 colored nicks, this one will be used. If color is -, the color
484 is marked as chosen automatically, which means it will not be
485 used in preset coloring mode, but will stay the same in on
486 coloring mode.
487 muc (jid|.|*) [on|preset|off|-]
489 Sets a MUC nick coloring mode. If a jid (. means currently
490 selected jid) is provided, the mode will apply to this specific
491 MUC. If * is used, it will be applied to all MUCs, except the
492 ones set by their jid. Mode on colors all nicks, preset only
493 the ones manually set by /color mucnick command and off colors
494 none. If not specified, defaults to on. Mode - removes the mode
495 from given JID, which means the global one will apply. You can
496 not remove the global mode. Default global coloring mode is
497 off.
498 /connect
500 Establish connection to the Jabber server.
501 /del
503 Delete the current buddy from our roster, unsubscribe from its
504 presence notification and unsubscribe it from ours.
505 /disconnect
507 Terminate the connection to the Jabber server.
508 Note: the roster is only available when the connection to the
510 server is active, so the buddylist is empty when disconnected.
511 /echo message
513 Display "message" in the log window.
514 /event #n|* accept|ignore|reject [event-specific arguments], /event
516 list
517 Tell mcabber what to do about pending events.
518 If the first parameter is *, the command will apply to all queued
520 events.
521 Event-specific arguments will be interpreted on event-to event
523 basis. The only built-in case, when argument is used is MUC
524 invitation reject - argument, if present, will be interpreted as
525 reject reason.
526 #N|* accept [event-specific arguments]
528 Event number #N/All events will be accepted
529 #N|* ignore [event-specific arguments]
531 Event number #N/All events will be ignored
532 #N|* reject [event-specific arguments]
534 Event number #N/All events will be rejected
535 list
537 List all pending events
538 /group fold|unfold|toggle [groupname]
540 This command changes the current group display.
541 fold [groupname]
543 Fold (shrink) the current/specified group tree in the roster
544 unfold [groupname]
546 Unfold (expand) the current/specified group tree in the roster
547 toggle [groupname]
549 Toggle the state (fold/unfold) of the current/specified tree
550 /help [command|+topic]
552 Display help for command "command" or topic "topic".
553 Example: "/help buffer"
555 /iline fchar|bchar|char_fdel|char_bdel|char_swap, /iline
557 fword|bword|word_bdel|word_fdel, /iline
558 word_upcase|word_downcase|word_capit, /iline
559 hist_beginning_search_bwd|hist_beginning_search_fwd, /iline
560 hist_prev|hist_next, /iline
561 iline_start|iline_end|iline_fdel|iline_bdel, /iline
562 iline_accept|iline_accept_down_hist, /iline compl_do|compl_cancel,
563 /iline send_multiline
564 Input line commands
565 fchar
567 Move to the next letter
568 bchar
570 Move to the previous letter
571 char_fdel
573 Delete the letter at cursor position
574 char_bdel
576 Delete the letter before cursor position
577 char_swap
579 Transpose chars
580 fword
582 Move the cursor forward to the end of the current or next word
583 bword
585 Move the cursor back to the start of the current or previous
586 word
587 word_bdel
589 Delete the word from cursor position to its start
590 word_fdel
592 Delete the word from cursor position to its end
593 word_upcase
595 Convert the word from cursor position to its end to upper case
596 word_downcase
598 Convert the word from cursor position to its end to down case
599 word_capit
601 Capitalize the word from cursor position to its end
602 hist_beginning_search_bwd
604 Search backward in the history for a line beginning with the
605 current line up to the cursor (this leaves the cursor in its
606 original position)
607 hist_beginning_search_fwd
609 Search forward in the history for a line beginning with the
610 current line up to the cursor (this leaves the cursor in its
611 original position)
612 hist_prev
614 Previous line of input line history
615 hist_next
617 Next line of input line history
618 iline_start
620 Go to the beginning of the input line
621 iline_end
623 Go to the end of the input line
624 iline_fdel
626 Delete from the cursor to the end of line
627 iline_bdel
629 Delete from beginning of the line to the cursor
630 iline_accept
632 Accept line
633 iline_accept_down_hist
635 Accept line and put the next history line in the input line
636 compl_do
638 Complete current word, in the input line
639 compl_cancel
641 Cancel completion
642 send_multiline
644 Send/terminate a multi-line message
645 /info
647 Display info on the selected entry (user, agent, group...).
648 For users, resources are displayed with the status, priority and
650 status message (if available) of each resource.
651 /module load|unload [-f] module, /module info module, /module [list]
653 Load, unload or show info on module.
654 load [-f] module
656 Loads specified module. If -f flag is specified, most of module
657 loading errors will be ignored.
658 unload [-f] module
660 Unloads specified module. Note: The force flag will not remove
661 any dependency on this module!
662 info module
664 Shows available information about this module.
665 [list]
667 Lists modules in a format: [modulename] [reference count]
668 ([Manually/Automatically loaded]) [any extra info, like version
669 or dependencies]
670 /move [groupname]
672 Move the current buddy to the requested group. If no group is
673 specified, then the buddy is moved to the default group. If the
674 group "groupname" doesn’t exist, it is created.
675 Tip: if the chatmode is enabled, you can use "/roster alternate" to
677 jump to the moved buddy.
678 /msay begin|verbatim|send|send_to|toggle|toggle_verbatim|abort
680 Send a multi-line message. To write a single message with several
681 lines, the multi-line mode should be used.
682 In multi-line mode, each line (except command lines) typed in the
684 input line will be added to the multi-line message. Once the
685 message is finished, it can be sent to the current selected buddy
686 with the "/msay send" command.
687 The begin subcommand enables multi-line mode. Note that it allows a
689 message subject to be specified.
690 The verbatim multi-line mode disables commands, so that it is
692 possible to enter lines starting with a slash. Only the "/msay"
693 command (with send or abort parameters) can be used to exit
694 verbatim mode.
695 The toggle subcommand can be bound to a key to use the multi-line
697 mode quickly (for example, "bind M13 = msay toggle" to switch using
698 the Meta-Enter combination).
699 begin [subject]
701 Enter multi-line mode
702 verbatim
704 Enter verbatim multi-line mode
705 send [-n|-h]
707 Send the current multi-line message to the currently selected
708 buddy
709 send_to [-n|-h] jid
711 Send the current multi-line message to "jid"
712 toggle|toggle_verbatim
714 Switch to/from multi-line mode (begin/send)
715 abort
717 Leave multi-line mode without sending the message
718 The -n or -h flags turn the message to "normal" or "headline" accordingly, as opposed to default "chat" message.
720 /otr key, /otr start|stop|info [jid], /otr fingerprint [jid [fpr]],
722 /otr smpq|smpr [jid] secret, /otr smpa [jid]
723 You can use the shortcut-jid "." for the currently selected
724 contact.
725 key
727 Print the fingerprint of your private key to the Status Buffer
728 start [jid]
730 Open an OTR channel to the specified jid (or the currently
731 selected contact)
732 stop [jid]
734 Close the OTR channel to the specified jid (or the currently
735 selected contact)
736 info [jid]
738 Show current OTR status for the specified jid (or the currently
739 selected contact)
740 fingerprint [jid [fpr]]
742 Show the active fingerprint of an OTR channel. If the
743 fingerprint is provided instead of "fpr", the fingerprint will
744 become trusted. If you replace "fpr" by some bogus string the
745 fingerprint will loose the trusted status.
746 smpq [jid] secret
748 Initiate the Socialist Millionaires Protocol with the secret
749 and the buddy
750 smpr [jid] secret
752 Respond to the Initiation of the jid with the secret
753 smpa [jid]
755 Abort the running Socialist Millionaires Protocol
756 /otrpolicy, /otrpolicy (default|jid)
758 (plain|manual|opportunistic|always)
759 You can use the shortcut-jid "." for the currently selected
760 contact.
761 (without arguments)
763 Prints all OTR policies to the status buffer
764 (default|jid) (plain|manual|opportunistic|always)
766 Sets either the default policy or the policy for the given jid
767 The plain policy should never be used, because you won’t be
768 able to receive or send any OTR encrypted messages. If you set
769 the policy to manual, you or your chat partner have to start
770 the OTR encryption by hand (e.g. with /otr start). The policy
771 "opportunistic" does that itself by sending a special
772 whitespace-sequence at the end of unencrypted messages. So the
773 other OTR-enabled chat client knows, that you want to use OTR.
774 Note that the first message will always be unencryted, if you
775 use this policy. With the policy "always" no message will be
776 sent in plain text. If you try to sent the first message
777 unencrypted, mcabber will try to establish an OTR channel.
778 Please resend your message, when you get the information that
779 the channel was established. If someone sends you plaintext
780 messages while the policy is set to "always", you’ll be able to
781 read the message but it won’t be saved to the history.
782 /pgp disable|enable|force|info [jid], /pgp setkey [jid [key]]
784 This command manipulates PGP settings for the specified jid (by
785 default the currently selected contact).
786 Please note that PGP encryption won’t be used if no remote PGP
788 support is detected, even if PGP is enabled with this command. You
789 can force PGP encryption with the "force" subcommand.
790 disable [jid]
792 Disable PGP encryption for jid (or the currently selected
793 contact)
794 enable [jid]
796 Enable PGP encryption for jid (or the currently selected
797 contact)
798 force [jid]
800 Enforce PGP encryption, even for offline messages, and always
801 assume the recipient has PGP support. If a message can’t be
802 encrypted (missing key or key id), the messages won’t be sent
803 at all. This option is ignored when PGP is disabled.
804 info [jid]
806 Show current PGP settings for the contact
807 setkey [jid [key]]
809 Set the PGP key to be used to encrypt message for this contact.
810 If no key is provided, the current key is erased. You can use
811 the shortcut-jid "." for the currently selected contact.
812 /quit
814 This command closes all connections and quit mcabber.
815 /rawxml send string
817 Send "string" (raw XML format) to the Jabber server.
818 No check is done on the string provided.
820 BEWARE! Use this only if you know what you are doing, or you could
822 terminate the connection.
823 Example: "/rawxml send <presence><show>away</show></presence>"
825 /rename name
827 Rename the current buddy or group to the given "name". If "name" is
828 -, the name is removed from the roster (and mcabber will display
829 the JID or username).
830 /request last|ping|time|vcard|version [jid]
832 Send a "IQ" query to the current buddy, or to the specified Jabber
833 user. If the resource is not provided with the jid, mcabber will
834 send the query to all known resources for this user.
835 last
837 Request "last" information (usually idle time)
838 ping
840 Send an XMPP Ping request. Note that you should use the full
841 JID since a ping sent to a bare JID will be handled by the
842 server.
843 time
845 Request time from the buddy
846 vcard
848 Request VCard from the buddy
849 version
851 Request version from the buddy
852 /room join|leave|names|nick|remove|topic|unlock|destroy, /room
854 privmsg|invite|whois|kick|ban|unban|role|affil, /room setopt
855 print_status|auto_whois [value], /room bookmark [add|del]
856 [-autojoin|+autojoin] [-|nick]
857 The room command handles Multi-User Chat room actions.
858 join [room [nick [pass]]]
860 Join "room", using "nick" as nickname. If no nickname is
861 provided (or if it is an empty string), the "nickname" option
862 value is used (see sample configuration file). If the currently
863 selected entry is correctly recognized as a room by mcabber,
864 the shortcut "." can be used instead of the full room id. A
865 password can be provided to enter protected rooms. If your
866 nickname contains space characters, use quotes.
867 leave [message]
869 Leave the current room
870 names [--detail|--short|--quiet|--compact]
872 Display members of the current room
873 nick newnick
875 Change your nickname in the current room
876 privmsg nick msg
878 Send private message "msg" to "nick"
879 remove
881 Remove the current room from the roster (you must have left
882 this room before)
883 topic -|newtopic
885 Set topic for current room
886 unlock
888 Unlock current room (if you are the owner)
889 destroy [reason]
891 Destroy the current room (use with care!)
892 whois nick
894 Display MUC information about "nick"
895 ban jid [reason]
897 Ban jid from the current room
898 unban jid
900 Unban jid from the current room
901 invite jid [reason]
903 Invite jid to the current room
904 kick nick [reason]
906 Kick "nick" from the current room
907 role nick role [reason]
909 Change nick’s role (role can be "none", "visitor",
910 "participant", "moderator")
911 affil jid affil [reason]
913 Change jid’s affiliation (affil can be "none", "member",
914 "admin", "owner")
915 setopt print_status|auto_whois [value]
917 Change settings for the current room For print_status, the
918 possible values are "default", "none", "in_and_out", "all". For
919 auto_whois, the possible values are "default", "off", "on".
920 When the value is "default", the options muc_print_status /
921 muc_auto_whois is used.
922 bookmark [add|del] [-autojoin|+autojoin] [-|nick]
924 Add, remove or update a bookmark (default is add). If autojoin
925 is set, mcabber will automatically join the MUC room when it
926 connects to the server. To see the list of bookmarks, use /room
927 bookmark in the status buffer.
928 /roster bottom|top|up|down|group_prev|group_next, /roster
930 alternate|unread_first|unread_next, /roster search bud, /roster
931 display|hide_offline|show_offline|toggle_offline, /roster
932 item_lock|item_unlock|item_toggle_lock, /roster hide|show|toggle,
933 /roster note [-|text]
934 The roster command manipulates the roster/buddylist.
935 Here are the available parameters:
937 bottom
939 Jump to the bottom of the roster
940 top
942 Jump to the top of the roster
943 up [n]
945 Move up [n lines] in the roster
946 down [n]
948 Move down [n lines] in the roster
949 group_prev
951 Jump to the previous group in the roster
952 group_next
954 Jump to the next group in the roster
955 alternate
957 Jump to alternate buddy. The "alternate" buddy is the last
958 buddy left while being in chat mode. This command is thus
959 especially useful after commands like "/roster unread_next"
960 (Ctrl-q).
961 unread_first
963 Jump to the first unread message
964 unread_next
966 Jump to the next unread message
967 search bud
969 Search for a buddy with a name or jid containing "bud" (only in
970 the displayed buddylist)
971 display [mask]
973 See or update the roster filter. The mask should contain the
974 shortcut letters of the status you want to see ([o]nline,
975 [f]ree_for_chat, [d]o_not_disturb, [n]ot_available, [a]way,
976 [_]offline). For example "ofdna" to display only connected
977 buddies.
978 hide_offline
980 Hide offline buddies (same as /roster display ofdna)
981 show_offline
983 Show offline buddies (same as /roster display ofdna_)
984 toggle_offline
986 Toggle display of offline buddies
987 item_lock [jid]
989 Lock the roster item so it remains visible regardless of its
990 status
991 item_unlock [jid]
993 Undo the effects of item_lock
994 item_toggle_lock [jid]
996 Invert the current lock flag
997 hide
999 Hide roster (full-width chat window)
1000 show
1002 Show roster
1003 toggle
1005 Toggle roster visibility
1006 note [-|text]
1008 Set/update/delete an annotation. If there is no text, the
1009 current item’s annotation is displayed — if you are in the
1010 status buffer, all notes are displayed. If text is "-", the
1011 note is erased.
1012 /say [-n|-h|--] text
1014 Send the "text" message to the currently selected buddy. It can be
1015 useful if you want to send a message beginning with a slash, for
1016 example.
1017 The "-n" flag turns the message to "normal" type, "-h" to
1019 "headline". "--" can be used to send chat message beginning with -n
1020 or -h.
1021 /say_to [-n|-h] [-q] [-f file] jid text
1023 Send the "text" message to the specified jid.
1024 Please note that this command doesn’t set the default resource for
1026 a contact, so if you want to send several messages to a specific
1027 resource you will have to use "/say_to" for each message.
1028 You can send a message to a specific resource of the currently
1030 selected contact by using /say_to ./resourcename message.
1031 The "-n" flag turns the message to "normal" type, "-h" to
1033 "headline". "--" can be used to send chat messages beginning with
1034 -n or -h.
1035 When "-q" is used, the message will be sent in the background and
1037 will not change the current active window.
1038 A text file can be provided with the "-f" switch (in which case
1040 there’s no need to pass a text argument after the jid, of course).
1041 /screen_refresh
1043 Refresh the mcabber screen.
1044 /set [option [= value]]
1046 Display or set an option value.
1047 Without arguments prints a list of all set options with their
1049 values
1050 /source pattern
1052 Read configuration files, that match glob pattern (sorted in
1053 alphabetical order).
1054 /status [online|avail|free|dnd|notavail|away [-|statusmessage]],
1056 /status message -|statusmessage
1057 Show or set the current status.
1058 If no status is specified, display the current status.
1060 If a status message is specified, it will overrride the message*
1062 variables (these variables can be set in the configuration file).
1063 If no relevant message* variable is set and no status message
1065 provided, the current status message is kept.
1066 If StatusMessage is "-", the current status message is cleared.
1068 With the "/status message" command, mcabber will update the message
1070 while preserving the status.
1071 /status_to jid online|avail|free|dnd|notavail|away [statusmessage],
1073 /status_to jid message statusmessage
1074 Send the requested status to the specified Jabber user.
1075 If the specified jid is ".", the current buddy is used.
1077 Note: this status will be overridden by subsequent "/status"
1079 commands. If you are using the auto-away feature, the status will
1080 overridden too.
1081 Note: The jid can include a resource (i.e. user@server/resource).
1083 /version
1085 Display current version of mcabber.
1086
1088 See the provided sample configuration file, which should be
1089 self-documenting.
1090
1092 The following files can be used by mcabber(1):
1093 $HOME/.mcabber/mcabberrc Default configuration file
1095 $HOME/.config/mcabber/mcabberrc Alternate location (can use XDG_CONFIG_HOME)
1096 $HOME/.mcabberrc Configuration file used if no other has been found
1097 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled
1098 /usr/share/mcabber/help/ Default directory for online help files
1099 /usr/lib/mcabber/ Default directory for modules
1100
1102 Certainly. Please tell me if you find one! :-) Please visit our website
1103 to find out about the MUC room and the bug tracker.
1104
1106 Written by Mikael BERTHE[1] and others (see AUTHORS file).
1107
1109 Main web site[2]
1110 Official wiki[3]
1112 MCabber MUC room[4]
1114
1116 Copyright (C) 2005-2017 Mikael Berthe and others.
1117 Free use of this software is granted under the terms of the GNU General
1119 Public License (GPL).
1120
1122 Mikael BERTHE <mcabber@lilotux.net>
1123 Author.
1124
1126 1. Mikael BERTHE
1127 mailto:mikael@lilotux.net
1128 2. Main web site
1130 http://mcabber.com/
1131 3. Official wiki
1133 http://wiki.mcabber.com/
1134 4. MCabber MUC room
1136 xmpp:mcabber@conf.lilotux.net
1137 1.1.0 May 2017 MCABBER(1)