author | Mikael Berthe <mikael@lilotux.net> |
Sun, 20 Nov 2005 00:12:53 +0100 | |
changeset 525 | c7f94f6e51f0 |
parent 522 | fdd1637db7f3 |
child 530 | 365e1ded7f1a |
permissions | -rw-r--r-- |
169 | 1 |
# Sample ~/.mcabber/mcabberrc file |
62 | 2 |
|
500
357086193b02
Add a comment about the config. file syntax
Mikael Berthe <mikael@lilotux.net>
parents:
477
diff
changeset
|
3 |
# Note about this file syntax: |
357086193b02
Add a comment about the config. file syntax
Mikael Berthe <mikael@lilotux.net>
parents:
477
diff
changeset
|
4 |
# - Leading and trailing spaces are ignored. |
357086193b02
Add a comment about the config. file syntax
Mikael Berthe <mikael@lilotux.net>
parents:
477
diff
changeset
|
5 |
# - Empty lines and lines beginning with a '#' are ignored. |
357086193b02
Add a comment about the config. file syntax
Mikael Berthe <mikael@lilotux.net>
parents:
477
diff
changeset
|
6 |
|
405
8154c417d80c
Update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
399
diff
changeset
|
7 |
# The jid will be the following: username@server |
8154c417d80c
Update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
399
diff
changeset
|
8 |
# If your jid's domain name is different from the server name, |
8154c417d80c
Update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
399
diff
changeset
|
9 |
# you can specify your complete jid as username. |
8154c417d80c
Update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
399
diff
changeset
|
10 |
# |
85 | 11 |
# If password is not given, it will be interactively asked for. |
12 |
# If port is not given, default Jabber port will be used. |
|
70 | 13 |
# Use ssl = 1 to enable SSL |
62 | 14 |
|
334
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
15 |
set username = yourusername |
338
7bd4ffee9497
Update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents:
334
diff
changeset
|
16 |
# Note: if the password contains leading or trailing spaces, you must |
7bd4ffee9497
Update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents:
334
diff
changeset
|
17 |
# enclose it with quotes: set password = " example password " |
334
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
18 |
#set password = yourpassword |
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
19 |
set server = your.jabber.server |
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
20 |
#set port = 5222 |
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
21 |
set ssl = 0 |
232 | 22 |
# If you don't know what a resource is, you can leave "mcabber" here. |
334
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
23 |
set resource = mcabber |
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
24 |
#set priority = 3 |
62 | 25 |
|
429 | 26 |
# Proxy |
27 |
# mcabber can use a proxy if it supports the CONNECT method |
|
28 |
# The proxy_user/proxy_pass variables are optional. |
|
29 |
#set proxy_host = "proxy-hostname" |
|
30 |
#set proxy_port = 3128 |
|
31 |
#set proxy_user = "username" |
|
32 |
#set proxy_pass = "password" |
|
33 |
||
113 | 34 |
# Keepalive |
35 |
# If you need a ping/keepalive to leave your connection open, you |
|
36 |
# can use the pinginterval. Setting this option to 0 disables the ping. |
|
37 |
# Default value is 40 seconds. |
|
334
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
38 |
#set pinginterval = 40 |
113 | 39 |
|
87 | 40 |
# Set hide_offline_buddies to 1 to display only connected buddies |
41 |
# in the roster. |
|
334
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
42 |
#set hide_offline_buddies = 0 |
62 | 43 |
|
113 | 44 |
# History logging |
45 |
# You can save the messages history: set logging = 1 |
|
177 | 46 |
# You can load (read) the messages history: set load_logs = 1 |
169 | 47 |
# Default logging directory (logging_dir) is $HOME/.mcabber/histo/ |
356
a30ca1b77fa2
Disable logging by default in the sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents:
355
diff
changeset
|
48 |
# Defaults for logging, load_logs are 0 (disabled) |
376
d37d8d661115
Update mcabberrc.example
Mikael Berthe <mikael@lilotux.net>
parents:
374
diff
changeset
|
49 |
# Note: the logging directory must exist if you enable logging, mcabber |
d37d8d661115
Update mcabberrc.example
Mikael Berthe <mikael@lilotux.net>
parents:
374
diff
changeset
|
50 |
# will not create it. |
356
a30ca1b77fa2
Disable logging by default in the sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents:
355
diff
changeset
|
51 |
#set logging = 1 |
334
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
52 |
#set load_logs = 1 |
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
53 |
#set logging_dir = /home/mikael/.mcabber/histo/ |
160 | 54 |
|
477 | 55 |
# Set log_muc_conf to 1 to enable MUC chatrooms logging (default = 0) |
56 |
# set log_muc_conf = 1 |
|
57 |
||
160 | 58 |
# External command for events |
59 |
# You can specify a script or process to be launched when an event occurs. |
|
525
c7f94f6e51f0
Update sample mcabberrc and eventcmd script
Mikael Berthe <mikael@lilotux.net>
parents:
522
diff
changeset
|
60 |
# |
c7f94f6e51f0
Update sample mcabberrc and eventcmd script
Mikael Berthe <mikael@lilotux.net>
parents:
522
diff
changeset
|
61 |
# If 'event_log_files' is set, a file is created and contains the body of |
c7f94f6e51f0
Update sample mcabberrc and eventcmd script
Mikael Berthe <mikael@lilotux.net>
parents:
522
diff
changeset
|
62 |
# the message (incoming messages only); the file name is the last parameter. |
c7f94f6e51f0
Update sample mcabberrc and eventcmd script
Mikael Berthe <mikael@lilotux.net>
parents:
522
diff
changeset
|
63 |
# If you enable this, you can specify the directory mcabber will use to |
c7f94f6e51f0
Update sample mcabberrc and eventcmd script
Mikael Berthe <mikael@lilotux.net>
parents:
522
diff
changeset
|
64 |
# create these messages with the 'event_log_dir' variable (default is the |
c7f94f6e51f0
Update sample mcabberrc and eventcmd script
Mikael Berthe <mikael@lilotux.net>
parents:
522
diff
changeset
|
65 |
# system temp dir, or MCABBERTMPDIR environment variable). Please note |
c7f94f6e51f0
Update sample mcabberrc and eventcmd script
Mikael Berthe <mikael@lilotux.net>
parents:
522
diff
changeset
|
66 |
# that mcabber won't delete these files, it's your script's job. |
c7f94f6e51f0
Update sample mcabberrc and eventcmd script
Mikael Berthe <mikael@lilotux.net>
parents:
522
diff
changeset
|
67 |
# |
355
c5a7a7273986
Add some external actions
Mikael Berthe <mikael@lilotux.net>
parents:
339
diff
changeset
|
68 |
# The command is called the following way: |
525
c7f94f6e51f0
Update sample mcabberrc and eventcmd script
Mikael Berthe <mikael@lilotux.net>
parents:
522
diff
changeset
|
69 |
# $events_command MSG IN jabber@id [file] (when receiving a message) |
355
c5a7a7273986
Add some external actions
Mikael Berthe <mikael@lilotux.net>
parents:
339
diff
changeset
|
70 |
# $events_command MSG OUT jabber@id (when sending a message) |
525
c7f94f6e51f0
Update sample mcabberrc and eventcmd script
Mikael Berthe <mikael@lilotux.net>
parents:
522
diff
changeset
|
71 |
# $events_command MSG MUC room_id [file] (when receiving a MUC message) |
355
c5a7a7273986
Add some external actions
Mikael Berthe <mikael@lilotux.net>
parents:
339
diff
changeset
|
72 |
# $events_command STATUS X jabber@id (new buddy status is X) |
c5a7a7273986
Add some external actions
Mikael Berthe <mikael@lilotux.net>
parents:
339
diff
changeset
|
73 |
# See sample script in contrib/ directory. |
334
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
74 |
#set events_command = /home/mikael/.mcabber/eventcmd |
525
c7f94f6e51f0
Update sample mcabberrc and eventcmd script
Mikael Berthe <mikael@lilotux.net>
parents:
522
diff
changeset
|
75 |
# |
c7f94f6e51f0
Update sample mcabberrc and eventcmd script
Mikael Berthe <mikael@lilotux.net>
parents:
522
diff
changeset
|
76 |
#set event_log_files = 0 |
c7f94f6e51f0
Update sample mcabberrc and eventcmd script
Mikael Berthe <mikael@lilotux.net>
parents:
522
diff
changeset
|
77 |
#set event_log_dir = /home/mikael/.mcabber/event_files |
113 | 78 |
|
374
bd5638c21834
Improve logging system (traces)
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
79 |
# Traces logging |
bd5638c21834
Improve logging system (traces)
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
80 |
# If you want advanced traces, please specify a file and a level here. |
bd5638c21834
Improve logging system (traces)
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
81 |
# There are currently 2 traceloglog levels: |
bd5638c21834
Improve logging system (traces)
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
82 |
# lvl 1: most events of the log window are written to the file |
bd5638c21834
Improve logging system (traces)
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
83 |
# lvl 2: debug logging (XML, etc.) |
bd5638c21834
Improve logging system (traces)
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
84 |
# Default is level 0, no trace logging |
bd5638c21834
Improve logging system (traces)
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
85 |
#set tracelog_level = 1 |
bd5638c21834
Improve logging system (traces)
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
86 |
#set tracelog_file = /home/mikael/mcabber.log |
113 | 87 |
|
525
c7f94f6e51f0
Update sample mcabberrc and eventcmd script
Mikael Berthe <mikael@lilotux.net>
parents:
522
diff
changeset
|
88 |
# Set the auto-away timeout, in seconds. If set to a value >0, |
c7f94f6e51f0
Update sample mcabberrc and eventcmd script
Mikael Berthe <mikael@lilotux.net>
parents:
522
diff
changeset
|
89 |
# mcabber will change your status to away if no real activity is detected |
c7f94f6e51f0
Update sample mcabberrc and eventcmd script
Mikael Berthe <mikael@lilotux.net>
parents:
522
diff
changeset
|
90 |
# (command, message, move in the buddylist...). Note: auto-away only changes |
c7f94f6e51f0
Update sample mcabberrc and eventcmd script
Mikael Berthe <mikael@lilotux.net>
parents:
522
diff
changeset
|
91 |
# the status when it is "available" (online) or "free_for_chat". |
c7f94f6e51f0
Update sample mcabberrc and eventcmd script
Mikael Berthe <mikael@lilotux.net>
parents:
522
diff
changeset
|
92 |
# See 'message_autoaway' below. |
c7f94f6e51f0
Update sample mcabberrc and eventcmd script
Mikael Berthe <mikael@lilotux.net>
parents:
522
diff
changeset
|
93 |
#set autoaway = 0 |
c7f94f6e51f0
Update sample mcabberrc and eventcmd script
Mikael Berthe <mikael@lilotux.net>
parents:
522
diff
changeset
|
94 |
|
511 | 95 |
# Status messages |
294
871e53769084
Allow one status message per Jabber status
Mikael Berthe <mikael@lilotux.net>
parents:
272
diff
changeset
|
96 |
# The "message" value will override all others, take care! |
334
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
97 |
#set message = Unique message status |
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
98 |
#set message_avail = I'm available |
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
99 |
#set message_free = I'm free for chat |
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
100 |
#set message_dnd = Please do not disturb |
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
101 |
#set message_notavail = I'm not available |
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
102 |
#set message_away = I'm away |
522 | 103 |
# |
104 |
# The auto-away message is only used when 'autoaway' is set. The previous |
|
105 |
# message will be restored when leaving auto-away status. If this message |
|
106 |
# isn't defined, the status message will stay unchanged. |
|
107 |
set message_autoaway = Auto-away (idle) |
|
294
871e53769084
Allow one status message per Jabber status
Mikael Berthe <mikael@lilotux.net>
parents:
272
diff
changeset
|
108 |
|
511 | 109 |
# Colors |
267 | 110 |
# Colors are: black, red, green, yellow, blue, magenta, cyan, white |
399 | 111 |
# You can use the "default" color, too (i.e. for transparent background) |
334
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
112 |
#set color_background = blue |
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
113 |
#set color_general = white |
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
114 |
#set color_newmessage = red |
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
115 |
#set color_rosternormal = magenta |
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
116 |
#set color_rosterselect = black |
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
117 |
#set color_backselected = cyan |
62 | 118 |
|
511 | 119 |
# Style |
517
d8f4a0fc77d3
Update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents:
511
diff
changeset
|
120 |
# Log window height (minimum 1, default 5) |
d8f4a0fc77d3
Update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents:
511
diff
changeset
|
121 |
#set log_win_height = 5 |
d8f4a0fc77d3
Update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents:
511
diff
changeset
|
122 |
# |
511 | 123 |
# Buddy name format (in status window): |
124 |
# - 0: (default) "<jid/resource>" |
|
125 |
# - 1: "name <jid/resource>" (name is omitted if same as the jid) |
|
126 |
# - 2: "name/resource" (if the name is the same as the jid, use <jid/res>) |
|
127 |
# - 3: "name" (if the name is the same as the jid, use <jid/res>) |
|
128 |
#set buddy_format = 2 |
|
517
d8f4a0fc77d3
Update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents:
511
diff
changeset
|
129 |
# |
d8f4a0fc77d3
Update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents:
511
diff
changeset
|
130 |
# Display the status changes in the chat buffers (default: 0, never) |
d8f4a0fc77d3
Update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents:
511
diff
changeset
|
131 |
# Values: 0: never 1: only connect/disconnect 2: all |
d8f4a0fc77d3
Update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents:
511
diff
changeset
|
132 |
#set show_status_in_buffer = 1 |
511 | 133 |
|
134 |
# Aliases |
|
334
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
135 |
alias online = status online |
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
136 |
alias away = status away |
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
137 |
alias dnd = status dnd |
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
138 |
alias notavail = status notavail |
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
139 |
|
511 | 140 |
# Key bindings |
334
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
141 |
# Ctlr-X (24) bound to /roster alternate |
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
142 |
bind 24 = roster alternate |
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
143 |
# F5 (269) bound to /roster toggle_offline (centericq-like, IIRC) |
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
144 |
bind 269 = roster toggle_offline |
475dccabe6f3
New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents:
322
diff
changeset
|
145 |