Root/mcabber/files/mcabberrc.example

Source at commit 1b3135c created 9 years 13 days ago.
By Xiangfu Liu, new package: SDL-widgets: a GUI toolkit on top of the SDL libraries
1# Sample ~/.mcabber/mcabberrc file
2
3# Note about this file syntax:
4# - Leading and trailing spaces are ignored.
5# - Empty lines and lines beginning with a '#' are ignored.
6
7# Please provide your Jabber (XMPP) identifier:
8set jid = yourusername@domain
9
10# If password is not given, it will be interactively asked for.
11# Note: if the password contains leading or trailing spaces, you must
12# enclose it with quotes: set password = " example password "
13#set password = yourpassword
14
15# You can provide a server name if you want mcabber to connect
16# to a specific server.
17#set server = your.jabber.server
18
19# If port is not given, mcabber will try to find it out.
20#set port = 5222
21
22# If you don't know what a resource is, do not set it.
23# Set disable_random_resource to 1 if you don't want mcabber to add a random
24# suffix to the resource name.
25#set resource = mcabber
26#set disable_random_resource = 0
27
28#set priority = 3
29#set priority_away = 0
30
31# Set 'ignore_self_presence' to 1 if you do not want to see your own
32# presence in your roster (default: 0).
33set ignore_self_presence = 1
34
35# SSL/TLS options:
36# TLS is now regarded as the default encryption for connecting to jabber.
37# You can require TLS by setting tls to 1. If your jabber server
38# still doesn't support TLS, you can use the old-style SSL by setting
39# ssl to 1. It's not possible to use old-style SSL and TLS together.
40#set ssl = 0
41set tls = 1
42# Moreover, it's possible to check whether the fingerprint of the
43# ssl certificate matches ssl_fingerprint.
44# You can get the fingerprint of your server either with gnutls or openssl:
45# 1. gnutls-cli -p 5223 $your_server
46# 2. openssl s_client -connect $your_server:5223 | \
47# openssl x509 -fingerprint -md5 -noout
48#set ssl_fingerprint = 97:5C:00:3F:1D:77:45:25:E2:C5:70:EC:83:C8:87:EE
49# Set ssl_ignore_checks to 1 to disable all certificate checks except the
50# fingerprint check.
51#set ssl_ignore_checks = 0
52
53# PGP support
54# Set pgp to 1 to enable OpenPGP.
55# To sign outgoing messages, select your private key id with
56# the pgp_private_key option. You cannot change these options once
57# mcabber is running.
58# Note: you can get the Key Id with gpg: "gpg --list-keys --keyid-format long"
59#set pgp = 0
60#set pgp_private_key = "C9940A9BB0B92210"
61#
62# You can set your PGP passhrase here, although it's NOT advised.
63#set pgp_passphrase = "PGPpassword"
64#
65# If you don't like the default number of passphrase retries (2), you
66# can change it here. If this number is < 0, mcabber will keep asking
67# until the passphrase is good.
68#set pgp_passphrase_retries = 2
69
70# Conference nickname
71# This nickname is used when joining a room, when no nick is explicitly
72# specified by the user. Note that when the nickname option is not set,
73# the jid variable can be used.
74#set nickname = Abitbol
75
76# Proxy
77# mcabber can use a proxy if it supports the CONNECT method
78# The proxy_user/proxy_pass variables are optional.
79#set proxy_host = "proxy-hostname"
80#set proxy_port = 3128
81#set proxy_user = "username"
82#set proxy_pass = "password"
83
84# Keepalive
85# If you need a ping/keepalive to leave your connection open, you
86# can use the pinginterval. Setting this option to 0 disables the ping.
87# Default value is 40 seconds.
88#set pinginterval = 40
89
90# Language
91# Help files have been translated into a few languages.
92# You can set lang to a semicolon separated list of the following
93# values: en, cs, de, fr, it, nl, pl, ru, uk. If you omit this,
94# mcabber will try to autodetect it from your locale, with fallback
95# to en.
96# You also can specify a list of directories, where help is located,
97# for example, if your mcabber is installed with another prefix than
98# your modules.
99# This may be convenient to print help not into the status buffer, but into
100# currently opened buffer. For that set help_to_current option.
101#set lang = en
102#set help_dirs = "/usr/share/mcabber/help;~/share/mcabber/help"
103#set help_to_current = 0
104
105# Aspell
106# If your mcabber has been built with Aspell support, you can enable spell
107# checking with the following options (you can't change them once mcabber is
108# running).
109#set spell_enable = 1
110#set spell_lang = en_US
111#set spell_encoding = iso8859-1
112#set spell_encoding = UTF-8
113
114# History
115# Number of lines to remember for the command line history
116# (default: 0, unlimited).
117set cmdhistory_lines = 250
118
119# You can set up a mask to filter buddies and display them according to
120# their status. The mask should contain the shortcut letters of the
121# status you want to see ([o]nline, [f]ree_for_chat, [d]o_not_disturb,
122# [n]ot_available, [a]way, [_]offline).
123# For example, to display everybody the filter should be "ofdna_" (default).
124# To display only the connected buddies, use "ofdna".
125# Please note that this option is only used at startup (once mcabber is
126# running you can use "/roster display").
127#set roster_display_filter = ofdna_
128
129# Typing notifications, Chat States, Events (XEP-22/85)
130# Set disable_chatstates to 1 if you don't want to use typing notifications.
131# Note: changing this option once mcabber is running has no effect.
132#set disable_chatstates = 0
133
134# History logging
135# You can save the messages history: set logging = 1
136# Set 'logging_ignore_status' to 1 if you do not want to save status changes
137# (and status messages) to the log files (default: 0).
138# You can load (read) the messages history: set load_logs = 1
139# If you enable load_logs, you can use the 'max_history_age' setting below.
140# Default logging directory (logging_dir) is $HOME/.mcabber/histo/
141# Defaults for logging, load_logs are 0 (disabled)
142# Note: the logging directory must exist if you enable logging, mcabber
143# will not create it.
144# Note: these options, except 'max_history_age' and 'max_history_blocks',
145# are used at startup time.
146#set logging = 1
147#set load_logs = 1
148#set logging_dir = ~/.mcabber/histo/
149#set logging_ignore_status = 1
150
151# Set log_muc_conf to 1 to enable MUC chatrooms logging (default = 0)
152#set log_muc_conf = 1
153# Set load_muc_logs to 1 to read MUC chatrooms logs (default = 0). These
154# logs will be displayed in the buffer window _before_ any history received
155# from the server.
156#set load_muc_logs = 0
157
158# When load_logs (or load_muc_logs) is enabled, you can specify a maximum
159# number of history days to load into memory with max_history_age.
160# Default = 0 (disabled -- everything is loaded)
161# Note: this option is only used when reading history files, not later.
162#set max_history_age = 0
163
164# mcabber can store the list of unread messages in a state file,
165# so that the message flags are set back at next startup.
166# Note that 'logging' must be enabled for this feature to work.
167#set statefile = ~/.mcabber/mcabber.state
168
169# You can specify a maximum number of data blocks per buffer (1 block contains
170# about 8kB). The default is 0 (unlimited). If set, this value must be > 2.
171set max_history_blocks = 8
172
173# IQ settings
174# Set iq_version_hide_os to 1 if you do not want to allow people to retrieve
175# your OS version.
176#set iq_version_hide_os = 0
177#
178# Set iq_last_disable to 1 if you want to disable response to jabber:iq:last
179# queries (XEP-0012). Set iq_last_disable_when_notavail to 1 if you want
180# to disable Last Activity reports only when the not-available status is set.
181# (Default is 0 for both options)
182#set iq_last_disable = 0
183#set iq_last_disable_when_notavail = 1
184#
185# Set iq_hide_requests to 1 if you don't want received IQ requests to be
186# displayed in the status window (default: 0).
187#set iq_hide_requests = 1
188
189# Modules
190# If mcabber is built with modules support, you can specify the path
191# to the directory where your modules reside. Though, default compiled-in
192# value should be appropriate.
193#set modules_dir = /usr/lib/mcabber/
194
195# Beep
196# Set beep_on_message to 1 if you want mcabber to beep when receiving
197# a new message (except in chatrooms). If you want a more sophisticated
198# system (e.g. play a sound), have a look at 'events_command' below.
199#set beep_on_message = 0
200
201# External command for events
202# You can specify a script or process to be launched when an event occurs.
203# Set 'events_ignore_active_window' to 1 if you don't want the script to
204# be run for a message to the current active window (default: 0).
205#
206# If 'event_log_files' is set, a file is created and contains the body of
207# the message (incoming messages only); the file name is the last parameter.
208# If you enable this, you can specify the directory mcabber will use to
209# create these messages with the 'event_log_dir' variable (default is the
210# system temp dir, or MCABBERTMPDIR environment variable). Please note
211# that mcabber won't delete these files, it's your script's job.
212#
213# The command is called the following way:
214# $events_command MSG IN jabber@id [file] (when receiving a message)
215# $events_command MSG OUT jabber@id (when sending a message)
216# $events_command MSG MUC room_id [file] (when receiving a MUC message)
217# $events_command STATUS X jabber@id (new buddy status is X)
218# $events_command UNREAD "N x y z" (number of unread buddy buffers)
219# (x=attention y=muc unread buffers z=muc unread buffers with attention sign)
220# See sample script in contrib/ directory.
221#set events_command = ~/.mcabber/eventcmd
222#
223#set events_ignore_active_window = 0
224#
225#set event_log_files = 0
226#set event_log_dir = ~/.mcabber/event_files
227
228# If you set 'eventcmd_use_nickname' to 1, mcabber will pass the nickname
229# (if it is defined) to the event script instead of the JID (default: 0).
230#set eventcmd_use_nickname = 0
231
232# External command status check
233# You can request mcabber to inspect exit status value after each
234# events_command. If this option is set, mcabber will beep if the
235# exit value is 2.
236#set eventcmd_checkstatus = 0
237
238# Internal hooks
239# You can ask mcabber to execute an internal command when a special event
240# occurs (for example when it connects to the server).
241#
242# 'hook-post-connect' is executed when mcabber has connected to the server
243# and the roster has been received.
244#set hook-post-connect = status dnd
245#
246# 'hook-pre-disconnect' is executed just before mcabber disconnects from
247# the server.
248#set hook-pre-disconnect = say_to foo@bar Goodbye!
249
250# FIFO
251# mcabber can create a FIFO named pipe and listen to this pipe for commands.
252# Default: disabled.
253# Set 'fifo_hide_commands' to 1 if you don't want to see the FIFO commands
254# in the log window (they will still be written to the tracelog file).
255# When FIFO is configured, you can turn it off and on in real time with
256# the 'fifo_ignore' option (default: 0). When set to 1, the FIFO input is
257# still read but it is discarded.
258#set fifo_name = ~/.mcabber/mcabber.fifo
259#set fifo_hide_commands = 0
260#set fifo_ignore = 0
261
262# Traces logging
263# If you want advanced traces, please specify a file and a level here.
264# There are currently 4 tracelog levels:
265# lvl 1: most events of the log window are written to the file
266# lvl 2: Loudmouth verbose logging
267# lvl 3: debug logging (XML, etc.)
268# lvl 4: noisy debug logging (Loudmouth parser...)
269# Default is level 0, no trace logging
270#set tracelog_level = 1
271#set tracelog_file = ~/.mcabber/mcabber.log
272
273# Set the auto-away timeout, in seconds. If set to a value >0,
274# mcabber will change your status to away if no real activity is detected
275# (command, message, move in the buddylist...). Note: auto-away only changes
276# the status when it is "available" (online) or "free_for_chat".
277# See 'message_autoaway' below.
278#set autoaway = 0
279
280# Message blocking
281# Set 'block_unsubscribed' to 1 if you want to block (drop) incoming
282# messages from people you haven't authorized. (default: 0)
283#set block_unsubscribed = 0
284#
285# Set 'delete_on_reject' to 1 if you want to delete buddies from your
286# roster when you reject their subscription request. (default: 0)
287# (See documentation for /event)
288# The buddy is actually deleted only if there is no other subscription,
289# so for example if you are subscribed to this buddy's presence updates it
290# won't be deleted.
291#set delete_on_reject = 0
292
293# MUC
294# Set 'muc_flag_joins' to 1 if you want the MUC rooms to be flagged in
295# the roster when somebody joins a room. Set it to 2 if you want a flag
296# for leaves too.
297#set muc_flag_joins = 0
298# Set 'muc_print_status' to see status changes in MUC rooms:
299# 1: (none) do not display joining/leaving members
300# 2: (in_and_out) display joining/leaving members
301# 3: (all) display joining/leaving members and member status changes
302# (default: in_and_out)
303#set muc_print_status = 2
304# Set 'muc_auto_whois' to 1 if you want to call /room whois each time
305# somebody joins a room. (default: 0)
306#set muc_auto_whois = 0
307#
308# Set 'muc_disable_nick_hl' to 1 if you don't want mcabber to color lines
309# containing your nickname in a MUC room.
310#set muc_disable_nick_hl = 0
311#
312# Set 'muc_completion_suffix' if you want mcabber to append a string to
313# suggested nicknames (only at the beginning of a line), like ":" or ",".
314# (Default: none)
315#set muc_completion_suffix = ": "
316
317# Status messages
318# The 'message' value will override all others, take care!
319#set message = Unique message status
320#set message_avail = I'm available
321#set message_free = I'm free for chat
322#set message_dnd = Please do not disturb
323#set message_notavail = I'm not available
324#set message_away = I'm away
325#
326# The auto-away message is only used when 'autoaway' is set. The previous
327# message will be restored when leaving auto-away status. If this message
328# isn't defined, the status message will stay unchanged.
329set message_autoaway = Auto-away (idle)
330
331# Escape timeout delay (ESCDELAY)
332# The ESCDELAY variable specifies the time, in milliseconds, for which
333# the ncurses interface will await a character sequence.
334# The default is 1000 (1 second).
335# If you want mcabber to react faster after hitting Escape, you can lower
336# this value by setting the ESCDELAY environment variable or setting the
337# 'escdelay' option.
338set escdelay = 50
339
340# Colors
341# Colors are: black, red, green, yellow, blue, magenta, cyan, white
342# For text colors (i.e. not background and bg* colors) you can also use
343# the "bright" prefix to get a bright/bold color. Example: brightblue
344# You can use the "default" color, too (i.e. for transparent background).
345# If your terminal supports 256 colors, you can use the color number
346# directly (16-255).
347#
348# Have a look at the contrib/themes/ directory to see some sample
349# color settings.
350#
351# background: background color of the chat window and the log window
352# general: text color in the chat window and the log window
353# info: text color in the chat window for info messages
354# msgin: text color in the chat window for incoming messages
355# msgout: text color in the chat window for outgoing messages
356# msghl: text color in the chat window for highlighted messages (MUC)
357# bgstatus: background color of the status lines
358# status: text color of the status lines
359# roster: text color of the roster (buddylist) normal items
360# bgrostersel: background color of the selected roster item
361# rostersel: text color of the selected roster item
362# rosterselmsg:text color of the selected roster item, if there is a new msg
363# rosternewmsg: text color of items with unread messages
364#
365#set color_background = black
366#set color_general = white
367#set color_info = white
368#set color_msgin = white
369#set color_msgout = cyan
370#set color_msghl = yellow
371#set color_bgstatus = blue
372#set color_status = white
373#set color_roster = green
374#set color_bgrostersel = cyan
375#set color_rostersel = blue
376#set color_rosterselmsg = red
377#set color_rosternewmsg = red
378
379# You can color roster items by their status and JID. For example, to have
380# all roster items white, just all contacts from jabber.org that are away,
381# not available or do not disturb yellow, you do this:
382#
383#color roster * * white
384#color roster adn *@jabber.org yellow
385
386# You can let mcabber color nicks in MUC.
387# These colors will by used automatically:
388#set nick_colors = red green blue
389# This turns coloring of all mucs on:
390#color muc * on
391#
392# If you want someone's nick to be the same all the time:
393#color mucnick my_friend yellow
394
395# Style
396# Note: the 'log_win_height' and 'roster_width' values below can be set
397# in real time when mcabber is running. Refresh the screen (Ctrl-l) to
398# use the new values.
399#
400# Log window height (minimum 1, default 5)
401#set log_win_height = 5
402# Buddylist window width (minimum 2, default 24)
403#set roster_width=24
404#
405# The options 'log_win_on_top' and 'roster_win_on_right' can change the
406# position of the log window (top/bottom) and the position of the roster
407# (left/right).
408#set log_win_on_top = 0
409#set roster_win_on_right = 0
410#
411# By default, the displayed name of a contact in the roster window will
412# be the JID if no name has been specified. You can use the following
413# option if you only want to see the username part.
414#set roster_hide_domain = 0
415#
416# Buddy name format (in status window):
417# - 0: (default) "<jid/resource>"
418# - 1: "name <jid/resource>" (name is omitted if same as the JID)
419# - 2: "name/resource" (if the name is the same as the JID, use <jid/res>)
420# - 3: "name" (if the name is the same as the JID, use <jid/res>)
421#set buddy_format = 2
422#
423# Time format:
424# - 0: (default) Date and time
425# - 1: Time only
426# - 2: None
427#set time_prefix = 0
428#
429# When a contact sends "/me ", mcabber displays "*user ", where user
430# is the local part of the contact's JID.
431# If you want mcabber to display the complete bare JID (user@server.com),
432# set 'buddy_me_fulljid' to 1 (default: 0)
433#set buddy_me_fulljid = 1
434#
435# Display the status changes in the log window (default: 0, never)
436# Set 'log_display_presence' to 1 to enable.
437#set log_display_presence = 0
438#
439# Display the status changes in the chat buffers (default: 0, never)
440# Values: 0: never 1: only connect/disconnect 2: all
441#set show_status_in_buffer = 1
442#
443# Set 'log_display_sender' to 1 to display the message sender's JID in the
444# log window (default: 0, no)
445#set log_display_sender = 0
446#
447# Set 'info' to anything you'd like to see in your lower status line.
448#set info = woot
449#
450# Set 'url_regex' to a regular expression matching urls. If it matches an
451# url in an incoming messages, it'll print it to the log window.
452#set url_regex = "(((https?|ftps?|nntp)://)|www[.][-a-z0-9.]+|(mailto:|news:))(%[0-9A-F]{2}|[-_.!~*';/?:@&=+$,#[:alnum:]])+"
453
454# Contacts PGP information
455# You can provide a PGP key to be used for a given Jabber user, or
456# disable PGP on a per-account basis.
457# If you provide a KeyId for a contact, it will be compared to the key the
458# contact uses to sign their presence/messages and it will be used for
459# all outgoing encrypted messages (that is, the contact signature key will
460# be ignored).
461# Please note that the key must match exactly the id seen with /info.
462#pgp disable foo@bar.org
463#pgp setkey bar@foo.net C9940A9BB0B92210
464
465# OTR (Off-The-Record messaging) support
466# (Only available if mcabber is built with OTR support)
467# Set otr to 1 to enable OTR support.
468# You cannot change this option once mcabber is running.
469#set otr = 0
470#
471# OTR directory
472# You can specify the OTR directory with the otr_dir option
473# (default = ~/.mcabber/otr/).
474#set otr_dir = "~/.mcabber/otr/"
475#
476# You can set OTR policies from the configuration file (use /help otrpolicy
477# for the details).
478#otrpolicy default manual
479
480# Aliases
481alias me = say /me
482alias online = status online
483alias away = status away
484alias dnd = status dnd
485alias notavail = status notavail
486#alias names = room names
487#alias topic = room topic
488
489# Set use_mouse to 1 to map mouse buttons like keycodes.
490#set use_mouse = 1
491
492# Key bindings
493# Ctrl-q (17) bound to /roster unread_next
494bind 17 = roster unread_next
495# Ctrl-x (24) bound to /roster alternate
496bind 24 = roster alternate
497# F5 (269) bound to /roster toggle_offline (centericq-like, IIRC)
498bind 269 = roster toggle_offline
499# F12 (276) bound to /roster toggle
500bind 276 = roster toggle
501# Ctrl-Up/Ctrl-Down bound to /buffer up/down (like Ctrl-p/Ctrl-n)
502bind 521 = buffer up
503bind 514 = buffer down
504
505# Sample alias to join mcabber channel with "/jmc"
506#alias jmc = room join mcabber@conf.lilotux.net
507

Archive Download this file



interactive