mcabber/mcabberrc.example
author Mikael Berthe <mikael@lilotux.net>
Sat, 19 Nov 2005 16:54:42 +0100
changeset 522 fdd1637db7f3
parent 517 d8f4a0fc77d3
child 525 c7f94f6e51f0
permissions -rw-r--r--
Update documentation
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
169
0ed6099b5a54 [/trunk] Changeset 181 by mikael
mikael
parents: 162
diff changeset
     1
# Sample ~/.mcabber/mcabberrc file
62
db2a1826bafa [/trunk] Changeset 77 by mikael
mikael
parents:
diff changeset
     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
19f57e681252 [/trunk] Changeset 99 by mikael
mikael
parents: 70
diff changeset
    11
# If password is not given, it will be interactively asked for.
19f57e681252 [/trunk] Changeset 99 by mikael
mikael
parents: 70
diff changeset
    12
# If port is not given, default Jabber port will be used.
70
5b1249ce812d [/trunk] Changeset 84 by mikael
mikael
parents: 62
diff changeset
    13
# Use ssl = 1 to enable SSL
62
db2a1826bafa [/trunk] Changeset 77 by mikael
mikael
parents:
diff changeset
    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
9a6ba4b38e63 [/trunk] Changeset 245 by mikael
mikael
parents: 218
diff changeset
    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
db2a1826bafa [/trunk] Changeset 77 by mikael
mikael
parents:
diff changeset
    25
429
0bb3d37579aa Enable proxy support
Mikael Berthe <mikael@lilotux.net>
parents: 405
diff changeset
    26
# Proxy
0bb3d37579aa Enable proxy support
Mikael Berthe <mikael@lilotux.net>
parents: 405
diff changeset
    27
# mcabber can use a proxy if it supports the CONNECT method
0bb3d37579aa Enable proxy support
Mikael Berthe <mikael@lilotux.net>
parents: 405
diff changeset
    28
# The proxy_user/proxy_pass variables are optional.
0bb3d37579aa Enable proxy support
Mikael Berthe <mikael@lilotux.net>
parents: 405
diff changeset
    29
#set proxy_host = "proxy-hostname"
0bb3d37579aa Enable proxy support
Mikael Berthe <mikael@lilotux.net>
parents: 405
diff changeset
    30
#set proxy_port = 3128
0bb3d37579aa Enable proxy support
Mikael Berthe <mikael@lilotux.net>
parents: 405
diff changeset
    31
#set proxy_user = "username"
0bb3d37579aa Enable proxy support
Mikael Berthe <mikael@lilotux.net>
parents: 405
diff changeset
    32
#set proxy_pass = "password"
0bb3d37579aa Enable proxy support
Mikael Berthe <mikael@lilotux.net>
parents: 405
diff changeset
    33
113
8ac67e951eab [/trunk] Changeset 127 by mikael
mikael
parents: 87
diff changeset
    34
# Keepalive
8ac67e951eab [/trunk] Changeset 127 by mikael
mikael
parents: 87
diff changeset
    35
# If you need a ping/keepalive to leave your connection open, you
8ac67e951eab [/trunk] Changeset 127 by mikael
mikael
parents: 87
diff changeset
    36
# can use the pinginterval.  Setting this option to 0 disables the ping.
8ac67e951eab [/trunk] Changeset 127 by mikael
mikael
parents: 87
diff changeset
    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
8ac67e951eab [/trunk] Changeset 127 by mikael
mikael
parents: 87
diff changeset
    39
87
f600615c490d [/trunk] Changeset 101 by mikael
mikael
parents: 85
diff changeset
    40
# Set hide_offline_buddies to 1 to display only connected buddies
f600615c490d [/trunk] Changeset 101 by mikael
mikael
parents: 85
diff changeset
    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
db2a1826bafa [/trunk] Changeset 77 by mikael
mikael
parents:
diff changeset
    43
322
da138cdebf04 Implement auto-away mode
Mikael Berthe <mikael@lilotux.net>
parents: 294
diff changeset
    44
# Set the auto-away timeout, in seconds.  If set to a value >0,
da138cdebf04 Implement auto-away mode
Mikael Berthe <mikael@lilotux.net>
parents: 294
diff changeset
    45
# mcabber will change your status to away if no real activity is detected
339
e4ed1aec2988 Auto-away improvement
Mikael Berthe <mikael@lilotux.net>
parents: 338
diff changeset
    46
# (command, message, move in the buddylist...).  Note: auto-away only changes
e4ed1aec2988 Auto-away improvement
Mikael Berthe <mikael@lilotux.net>
parents: 338
diff changeset
    47
# the status when it is "available" (online) or "free_for_chat".
522
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 517
diff changeset
    48
# See 'message_autoaway' below.
322
da138cdebf04 Implement auto-away mode
Mikael Berthe <mikael@lilotux.net>
parents: 294
diff changeset
    49
#set autoaway = 0
62
db2a1826bafa [/trunk] Changeset 77 by mikael
mikael
parents:
diff changeset
    50
113
8ac67e951eab [/trunk] Changeset 127 by mikael
mikael
parents: 87
diff changeset
    51
# History logging
8ac67e951eab [/trunk] Changeset 127 by mikael
mikael
parents: 87
diff changeset
    52
# You can save the messages history: set logging = 1
177
a51ce78a0e2a [/trunk] Changeset 189 by mikael
mikael
parents: 169
diff changeset
    53
# You can load (read) the messages history: set load_logs = 1
169
0ed6099b5a54 [/trunk] Changeset 181 by mikael
mikael
parents: 162
diff changeset
    54
# 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
    55
# Defaults for logging, load_logs are 0 (disabled)
376
d37d8d661115 Update mcabberrc.example
Mikael Berthe <mikael@lilotux.net>
parents: 374
diff changeset
    56
# Note: the logging directory must exist if you enable logging, mcabber
d37d8d661115 Update mcabberrc.example
Mikael Berthe <mikael@lilotux.net>
parents: 374
diff changeset
    57
#       will not create it.
356
a30ca1b77fa2 Disable logging by default in the sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 355
diff changeset
    58
#set logging = 1
334
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
    59
#set load_logs = 1
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
    60
#set logging_dir = /home/mikael/.mcabber/histo/
160
44c6410b4845 [/trunk] Changeset 172 by mikael
mikael
parents: 139
diff changeset
    61
477
d11e5ce2582c Improve hk_message_in()
Mikael Berthe <mikael@lilotux.net>
parents: 453
diff changeset
    62
# Set log_muc_conf to 1 to enable MUC chatrooms logging (default = 0)
d11e5ce2582c Improve hk_message_in()
Mikael Berthe <mikael@lilotux.net>
parents: 453
diff changeset
    63
# set log_muc_conf = 1
d11e5ce2582c Improve hk_message_in()
Mikael Berthe <mikael@lilotux.net>
parents: 453
diff changeset
    64
160
44c6410b4845 [/trunk] Changeset 172 by mikael
mikael
parents: 139
diff changeset
    65
# External command for events
44c6410b4845 [/trunk] Changeset 172 by mikael
mikael
parents: 139
diff changeset
    66
# You can specify a script or process to be launched when an event occurs.
355
c5a7a7273986 Add some external actions
Mikael Berthe <mikael@lilotux.net>
parents: 339
diff changeset
    67
# The command is called the following way:
c5a7a7273986 Add some external actions
Mikael Berthe <mikael@lilotux.net>
parents: 339
diff changeset
    68
#   $events_command MSG IN jabber@id        (when receiving a message)
c5a7a7273986 Add some external actions
Mikael Berthe <mikael@lilotux.net>
parents: 339
diff changeset
    69
#   $events_command MSG OUT jabber@id       (when sending a message)
453
39e173645f9c External command is called for MUC messages
Mikael Berthe <mikael@lilotux.net>
parents: 429
diff changeset
    70
#   $events_command MSG MUC room_id         (when receiving a MUC message)
355
c5a7a7273986 Add some external actions
Mikael Berthe <mikael@lilotux.net>
parents: 339
diff changeset
    71
#   $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
    72
# 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
    73
#set events_command = /home/mikael/.mcabber/eventcmd
113
8ac67e951eab [/trunk] Changeset 127 by mikael
mikael
parents: 87
diff changeset
    74
374
bd5638c21834 Improve logging system (traces)
Mikael Berthe <mikael@lilotux.net>
parents: 364
diff changeset
    75
# Traces logging
bd5638c21834 Improve logging system (traces)
Mikael Berthe <mikael@lilotux.net>
parents: 364
diff changeset
    76
# 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
    77
# There are currently 2 traceloglog levels:
bd5638c21834 Improve logging system (traces)
Mikael Berthe <mikael@lilotux.net>
parents: 364
diff changeset
    78
#  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
    79
#  lvl 2: debug logging (XML, etc.)
bd5638c21834 Improve logging system (traces)
Mikael Berthe <mikael@lilotux.net>
parents: 364
diff changeset
    80
# Default is level 0, no trace logging
bd5638c21834 Improve logging system (traces)
Mikael Berthe <mikael@lilotux.net>
parents: 364
diff changeset
    81
#set tracelog_level = 1
bd5638c21834 Improve logging system (traces)
Mikael Berthe <mikael@lilotux.net>
parents: 364
diff changeset
    82
#set tracelog_file = /home/mikael/mcabber.log
113
8ac67e951eab [/trunk] Changeset 127 by mikael
mikael
parents: 87
diff changeset
    83
511
c7cdb9c6d7aa Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 500
diff changeset
    84
# Status messages
294
871e53769084 Allow one status message per Jabber status
Mikael Berthe <mikael@lilotux.net>
parents: 272
diff changeset
    85
# 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
    86
#set message = Unique message status
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
    87
#set message_avail     = I'm available
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
    88
#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
    89
#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
    90
#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
    91
#set message_away      = I'm away
522
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 517
diff changeset
    92
#
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 517
diff changeset
    93
# The auto-away message is only used when 'autoaway' is set.  The previous
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 517
diff changeset
    94
# message will be restored when leaving auto-away status.  If this message
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 517
diff changeset
    95
# isn't defined, the status message will stay unchanged.
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 517
diff changeset
    96
set message_autoaway  = Auto-away (idle)
294
871e53769084 Allow one status message per Jabber status
Mikael Berthe <mikael@lilotux.net>
parents: 272
diff changeset
    97
511
c7cdb9c6d7aa Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 500
diff changeset
    98
# Colors
267
8d3d5bd52da3 Improve color configuration
mikael@frmp8452
parents: 232
diff changeset
    99
# Colors are: black, red, green, yellow, blue, magenta, cyan, white
399
545384c43d48 Mention "default" color
Mikael Berthe <mikael@lilotux.net>
parents: 376
diff changeset
   100
# 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
   101
#set color_background   = blue
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
   102
#set color_general      = white
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
   103
#set color_newmessage   = red
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
   104
#set color_rosternormal = magenta
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
   105
#set color_rosterselect = black
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
   106
#set color_backselected = cyan
62
db2a1826bafa [/trunk] Changeset 77 by mikael
mikael
parents:
diff changeset
   107
511
c7cdb9c6d7aa Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 500
diff changeset
   108
# Style
517
d8f4a0fc77d3 Update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
   109
# Log window height (minimum 1, default 5)
d8f4a0fc77d3 Update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
   110
#set log_win_height = 5
d8f4a0fc77d3 Update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
   111
#
511
c7cdb9c6d7aa Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 500
diff changeset
   112
# Buddy name format (in status window):
c7cdb9c6d7aa Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 500
diff changeset
   113
# - 0: (default) "<jid/resource>"
c7cdb9c6d7aa Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 500
diff changeset
   114
# - 1: "name <jid/resource>" (name is omitted if same as the jid)
c7cdb9c6d7aa Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 500
diff changeset
   115
# - 2: "name/resource" (if the name is the same as the jid, use <jid/res>)
c7cdb9c6d7aa Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 500
diff changeset
   116
# - 3: "name" (if the name is the same as the jid, use <jid/res>)
c7cdb9c6d7aa Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 500
diff changeset
   117
#set buddy_format = 2
517
d8f4a0fc77d3 Update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
   118
#
d8f4a0fc77d3 Update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
   119
# 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
   120
# Values:  0: never  1: only connect/disconnect  2: all
d8f4a0fc77d3 Update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
   121
#set show_status_in_buffer = 1
511
c7cdb9c6d7aa Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 500
diff changeset
   122
c7cdb9c6d7aa Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 500
diff changeset
   123
# Aliases
334
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
   124
alias online   = status online
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
   125
alias away     = status away
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
   126
alias dnd      = status dnd
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
   127
alias notavail = status notavail
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
   128
511
c7cdb9c6d7aa Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 500
diff changeset
   129
# Key bindings
334
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
   130
# 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
   131
bind 24 = roster alternate
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
   132
# 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
   133
bind 269 = roster toggle_offline
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
   134