annotate mcabber/mcabberrc.example @ 2236:41e897b79c8d

Add a default value to mcabberrc.example comments
author Mikael Berthe <mikael@lilotux.net>
date Sat, 21 Nov 2015 18:23:30 +0100
parents 232c26383fc4
children 3d266140a8fb
rev   line source
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
1610
6db9f403f707 Replace 'username' with 'jid' in the configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1605
diff changeset
7 # Please provide your Jabber (XMPP) identifier:
6db9f403f707 Replace 'username' with 'jid' in the configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1605
diff changeset
8 set jid = yourusername@domain
6db9f403f707 Replace 'username' with 'jid' in the configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1605
diff changeset
9
85
19f57e681252 [/trunk] Changeset 99 by mikael
mikael
parents: 70
diff changeset
10 # If password is not given, it will be interactively asked for.
338
7bd4ffee9497 Update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 334
diff changeset
11 # 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
12 # 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
13 #set password = yourpassword
1610
6db9f403f707 Replace 'username' with 'jid' in the configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1605
diff changeset
14
2172
06669fc1810c Add support for using external password managers
Christian Burkert <post@cburkert.de>
parents: 2170
diff changeset
15 # Read password from output of the given command.
06669fc1810c Add support for using external password managers
Christian Burkert <post@cburkert.de>
parents: 2170
diff changeset
16 # This is a way to use password managers like 'pass' in order
06669fc1810c Add support for using external password managers
Christian Burkert <post@cburkert.de>
parents: 2170
diff changeset
17 # to avoid writing plain passwords into config files.
06669fc1810c Add support for using external password managers
Christian Burkert <post@cburkert.de>
parents: 2170
diff changeset
18 #set password_eval = "your command"
06669fc1810c Add support for using external password managers
Christian Burkert <post@cburkert.de>
parents: 2170
diff changeset
19
1610
6db9f403f707 Replace 'username' with 'jid' in the configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1605
diff changeset
20 # You can provide a server name if you want mcabber to connect
6db9f403f707 Replace 'username' with 'jid' in the configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1605
diff changeset
21 # to a specific server.
6db9f403f707 Replace 'username' with 'jid' in the configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1605
diff changeset
22 #set server = your.jabber.server
6db9f403f707 Replace 'username' with 'jid' in the configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1605
diff changeset
23
1943
11bda6d8daab Add default server for private messages
Mikael Berthe <mikael@lilotux.net>
parents: 1926
diff changeset
24 # To automatically append the server to the JID in say_to, use this option:
11bda6d8daab Add default server for private messages
Mikael Berthe <mikael@lilotux.net>
parents: 1926
diff changeset
25 #set default_server = jabber.org
11bda6d8daab Add default server for private messages
Mikael Berthe <mikael@lilotux.net>
parents: 1926
diff changeset
26
1610
6db9f403f707 Replace 'username' with 'jid' in the configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1605
diff changeset
27 # If port is not given, mcabber will try to find it out.
334
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
28 #set port = 5222
1610
6db9f403f707 Replace 'username' with 'jid' in the configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1605
diff changeset
29
1441
736b82610dfa mcabberrc: do not set a default resource
Mikael Berthe <mikael@lilotux.net>
parents: 1437
diff changeset
30 # If you don't know what a resource is, do not set it.
1530
29c505d43b3e Use random resource suffix by default
Mikael Berthe <mikael@lilotux.net>
parents: 1526
diff changeset
31 # Set disable_random_resource to 1 if you don't want mcabber to add a random
29c505d43b3e Use random resource suffix by default
Mikael Berthe <mikael@lilotux.net>
parents: 1526
diff changeset
32 # suffix to the resource name.
1441
736b82610dfa mcabberrc: do not set a default resource
Mikael Berthe <mikael@lilotux.net>
parents: 1437
diff changeset
33 #set resource = mcabber
1530
29c505d43b3e Use random resource suffix by default
Mikael Berthe <mikael@lilotux.net>
parents: 1526
diff changeset
34 #set disable_random_resource = 0
1610
6db9f403f707 Replace 'username' with 'jid' in the configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1605
diff changeset
35
334
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
36 #set priority = 3
1419
fb438482b28e New option to customize the away/notavail priority (Michael Gehring)
Mikael Berthe <mikael@lilotux.net>
parents: 1417
diff changeset
37 #set priority_away = 0
62
db2a1826bafa [/trunk] Changeset 77 by mikael
mikael
parents:
diff changeset
38
1446
49c8be874344 Add option 'ignore_self_presence'
Mikael Berthe <mikael@lilotux.net>
parents: 1444
diff changeset
39 # Set 'ignore_self_presence' to 1 if you do not want to see your own
2201
1c8ca1a8e5fe Clarify 'ignore_self_presence' description
Mikael Berthe <mikael@lilotux.net>
parents: 2190
diff changeset
40 # presence in your roster (default: 0). Other resources will still be
1c8ca1a8e5fe Clarify 'ignore_self_presence' description
Mikael Berthe <mikael@lilotux.net>
parents: 2190
diff changeset
41 # displayed.
1446
49c8be874344 Add option 'ignore_self_presence'
Mikael Berthe <mikael@lilotux.net>
parents: 1444
diff changeset
42 set ignore_self_presence = 1
49c8be874344 Add option 'ignore_self_presence'
Mikael Berthe <mikael@lilotux.net>
parents: 1444
diff changeset
43
1598
a087125d8fc8 Replace libjabber with loudmouth
franky
parents: 1590
diff changeset
44 # SSL/TLS options:
a087125d8fc8 Replace libjabber with loudmouth
franky
parents: 1590
diff changeset
45 # TLS is now regarded as the default encryption for connecting to jabber.
1605
79f3b780821a Update mcabberrc.example
Mikael Berthe <mikael@lilotux.net>
parents: 1598
diff changeset
46 # You can require TLS by setting tls to 1. If your jabber server
1598
a087125d8fc8 Replace libjabber with loudmouth
franky
parents: 1590
diff changeset
47 # still doesn't support TLS, you can use the old-style SSL by setting
1605
79f3b780821a Update mcabberrc.example
Mikael Berthe <mikael@lilotux.net>
parents: 1598
diff changeset
48 # ssl to 1. It's not possible to use old-style SSL and TLS together.
79f3b780821a Update mcabberrc.example
Mikael Berthe <mikael@lilotux.net>
parents: 1598
diff changeset
49 #set ssl = 0
1598
a087125d8fc8 Replace libjabber with loudmouth
franky
parents: 1590
diff changeset
50 set tls = 1
a087125d8fc8 Replace libjabber with loudmouth
franky
parents: 1590
diff changeset
51 # Moreover, it's possible to check whether the fingerprint of the
a087125d8fc8 Replace libjabber with loudmouth
franky
parents: 1590
diff changeset
52 # ssl certificate matches ssl_fingerprint.
a087125d8fc8 Replace libjabber with loudmouth
franky
parents: 1590
diff changeset
53 # You can get the fingerprint of your server either with gnutls or openssl:
a087125d8fc8 Replace libjabber with loudmouth
franky
parents: 1590
diff changeset
54 # 1. gnutls-cli -p 5223 $your_server
a087125d8fc8 Replace libjabber with loudmouth
franky
parents: 1590
diff changeset
55 # 2. openssl s_client -connect $your_server:5223 | \
a087125d8fc8 Replace libjabber with loudmouth
franky
parents: 1590
diff changeset
56 # openssl x509 -fingerprint -md5 -noout
1610
6db9f403f707 Replace 'username' with 'jid' in the configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1605
diff changeset
57 #set ssl_fingerprint = 97:5C:00:3F:1D:77:45:25:E2:C5:70:EC:83:C8:87:EE
1598
a087125d8fc8 Replace libjabber with loudmouth
franky
parents: 1590
diff changeset
58 # Set ssl_ignore_checks to 1 to disable all certificate checks except the
a087125d8fc8 Replace libjabber with loudmouth
franky
parents: 1590
diff changeset
59 # fingerprint check.
a087125d8fc8 Replace libjabber with loudmouth
franky
parents: 1590
diff changeset
60 #set ssl_ignore_checks = 0
938
40175f3dcef7 SSL server certificate verification
Jefferson Ogata <ogata@antibozo.net>
parents: 919
diff changeset
61
1042
8a395c2cafc4 Initial PGP support (decrypt)
Mikael Berthe <mikael@lilotux.net>
parents: 993
diff changeset
62 # PGP support
8a395c2cafc4 Initial PGP support (decrypt)
Mikael Berthe <mikael@lilotux.net>
parents: 993
diff changeset
63 # Set pgp to 1 to enable OpenPGP.
8a395c2cafc4 Initial PGP support (decrypt)
Mikael Berthe <mikael@lilotux.net>
parents: 993
diff changeset
64 # To sign outgoing messages, select your private key id with
8a395c2cafc4 Initial PGP support (decrypt)
Mikael Berthe <mikael@lilotux.net>
parents: 993
diff changeset
65 # the pgp_private_key option. You cannot change these options once
8a395c2cafc4 Initial PGP support (decrypt)
Mikael Berthe <mikael@lilotux.net>
parents: 993
diff changeset
66 # mcabber is running.
1068
6646d2ed7f74 Allow pgp commands in config file, update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1042
diff changeset
67 # Note: you can get the Key Id with gpg: "gpg --list-keys --keyid-format long"
1042
8a395c2cafc4 Initial PGP support (decrypt)
Mikael Berthe <mikael@lilotux.net>
parents: 993
diff changeset
68 #set pgp = 0
1068
6646d2ed7f74 Allow pgp commands in config file, update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1042
diff changeset
69 #set pgp_private_key = "C9940A9BB0B92210"
1042
8a395c2cafc4 Initial PGP support (decrypt)
Mikael Berthe <mikael@lilotux.net>
parents: 993
diff changeset
70 #
8a395c2cafc4 Initial PGP support (decrypt)
Mikael Berthe <mikael@lilotux.net>
parents: 993
diff changeset
71 # You can set your PGP passhrase here, although it's NOT advised.
8a395c2cafc4 Initial PGP support (decrypt)
Mikael Berthe <mikael@lilotux.net>
parents: 993
diff changeset
72 #set pgp_passphrase = "PGPpassword"
1313
d1d12a09b04a Make passphrase entry retries customizable (suggested by Till Maas)
Mikael Berthe <mikael@lilotux.net>
parents: 1311
diff changeset
73 #
d1d12a09b04a Make passphrase entry retries customizable (suggested by Till Maas)
Mikael Berthe <mikael@lilotux.net>
parents: 1311
diff changeset
74 # If you don't like the default number of passphrase retries (2), you
d1d12a09b04a Make passphrase entry retries customizable (suggested by Till Maas)
Mikael Berthe <mikael@lilotux.net>
parents: 1311
diff changeset
75 # can change it here. If this number is < 0, mcabber will keep asking
d1d12a09b04a Make passphrase entry retries customizable (suggested by Till Maas)
Mikael Berthe <mikael@lilotux.net>
parents: 1311
diff changeset
76 # until the passphrase is good.
1713
5acc6eb01988 Fix typo in config. file (spotted by calico.jeff)
Mikael Berthe <mikael@lilotux.net>
parents: 1679
diff changeset
77 #set pgp_passphrase_retries = 2
2233
90c25a29fb35 New option: 'gpg_path'
Holger Weiß <holger@zedat.fu-berlin.de>
parents: 2207
diff changeset
78 #
90c25a29fb35 New option: 'gpg_path'
Holger Weiß <holger@zedat.fu-berlin.de>
parents: 2207
diff changeset
79 # You can specify the path to the gpg binary, e.g. to force the use of
90c25a29fb35 New option: 'gpg_path'
Holger Weiß <holger@zedat.fu-berlin.de>
parents: 2207
diff changeset
80 # GnuPG version 1 on systems which have both versions installed.
90c25a29fb35 New option: 'gpg_path'
Holger Weiß <holger@zedat.fu-berlin.de>
parents: 2207
diff changeset
81 #set gpg_path = /usr/bin/gpg
2234
232c26383fc4 New option: 'gpg_home'
Holger Weiß <holger@zedat.fu-berlin.de>
parents: 2233
diff changeset
82 #
232c26383fc4 New option: 'gpg_home'
Holger Weiß <holger@zedat.fu-berlin.de>
parents: 2233
diff changeset
83 # If GnuPG should use a custom configuration directory, you can set
232c26383fc4 New option: 'gpg_home'
Holger Weiß <holger@zedat.fu-berlin.de>
parents: 2233
diff changeset
84 # 'gpg_home' to the desired path.
232c26383fc4 New option: 'gpg_home'
Holger Weiß <holger@zedat.fu-berlin.de>
parents: 2233
diff changeset
85 #set gpg_home = ~/.mcabber/gpg
1042
8a395c2cafc4 Initial PGP support (decrypt)
Mikael Berthe <mikael@lilotux.net>
parents: 993
diff changeset
86
659
e61aa455c61b MUC: Add "nickname" option variable
Mikael Berthe <mikael@lilotux.net>
parents: 635
diff changeset
87 # Conference nickname
e61aa455c61b MUC: Add "nickname" option variable
Mikael Berthe <mikael@lilotux.net>
parents: 635
diff changeset
88 # This nickname is used when joining a room, when no nick is explicitly
e61aa455c61b MUC: Add "nickname" option variable
Mikael Berthe <mikael@lilotux.net>
parents: 635
diff changeset
89 # specified by the user. Note that when the nickname option is not set,
1610
6db9f403f707 Replace 'username' with 'jid' in the configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1605
diff changeset
90 # the jid variable can be used.
659
e61aa455c61b MUC: Add "nickname" option variable
Mikael Berthe <mikael@lilotux.net>
parents: 635
diff changeset
91 #set nickname = Abitbol
e61aa455c61b MUC: Add "nickname" option variable
Mikael Berthe <mikael@lilotux.net>
parents: 635
diff changeset
92
429
0bb3d37579aa Enable proxy support
Mikael Berthe <mikael@lilotux.net>
parents: 405
diff changeset
93 # Proxy
0bb3d37579aa Enable proxy support
Mikael Berthe <mikael@lilotux.net>
parents: 405
diff changeset
94 # mcabber can use a proxy if it supports the CONNECT method
0bb3d37579aa Enable proxy support
Mikael Berthe <mikael@lilotux.net>
parents: 405
diff changeset
95 # The proxy_user/proxy_pass variables are optional.
0bb3d37579aa Enable proxy support
Mikael Berthe <mikael@lilotux.net>
parents: 405
diff changeset
96 #set proxy_host = "proxy-hostname"
0bb3d37579aa Enable proxy support
Mikael Berthe <mikael@lilotux.net>
parents: 405
diff changeset
97 #set proxy_port = 3128
0bb3d37579aa Enable proxy support
Mikael Berthe <mikael@lilotux.net>
parents: 405
diff changeset
98 #set proxy_user = "username"
0bb3d37579aa Enable proxy support
Mikael Berthe <mikael@lilotux.net>
parents: 405
diff changeset
99 #set proxy_pass = "password"
0bb3d37579aa Enable proxy support
Mikael Berthe <mikael@lilotux.net>
parents: 405
diff changeset
100
113
8ac67e951eab [/trunk] Changeset 127 by mikael
mikael
parents: 87
diff changeset
101 # Keepalive
8ac67e951eab [/trunk] Changeset 127 by mikael
mikael
parents: 87
diff changeset
102 # If you need a ping/keepalive to leave your connection open, you
8ac67e951eab [/trunk] Changeset 127 by mikael
mikael
parents: 87
diff changeset
103 # can use the pinginterval. Setting this option to 0 disables the ping.
8ac67e951eab [/trunk] Changeset 127 by mikael
mikael
parents: 87
diff changeset
104 # Default value is 40 seconds.
334
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
105 #set pinginterval = 40
113
8ac67e951eab [/trunk] Changeset 127 by mikael
mikael
parents: 87
diff changeset
106
919
653c1cdfb589 Mention the "lang" variable
Mikael Berthe <mikael@lilotux.net>
parents: 899
diff changeset
107 # Language
653c1cdfb589 Mention the "lang" variable
Mikael Berthe <mikael@lilotux.net>
parents: 899
diff changeset
108 # Help files have been translated into a few languages.
1679
b2504df1c910 Update mcabberrc.example
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1628
diff changeset
109 # You can set lang to a semicolon separated list of the following
b2504df1c910 Update mcabberrc.example
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1628
diff changeset
110 # values: en, cs, de, fr, it, nl, pl, ru, uk. If you omit this,
b2504df1c910 Update mcabberrc.example
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1628
diff changeset
111 # mcabber will try to autodetect it from your locale, with fallback
b2504df1c910 Update mcabberrc.example
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1628
diff changeset
112 # to en.
b2504df1c910 Update mcabberrc.example
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1628
diff changeset
113 # You also can specify a list of directories, where help is located,
b2504df1c910 Update mcabberrc.example
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1628
diff changeset
114 # for example, if your mcabber is installed with another prefix than
b2504df1c910 Update mcabberrc.example
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1628
diff changeset
115 # your modules.
b2504df1c910 Update mcabberrc.example
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1628
diff changeset
116 # This may be convenient to print help not into the status buffer, but into
b2504df1c910 Update mcabberrc.example
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1628
diff changeset
117 # currently opened buffer. For that set help_to_current option.
919
653c1cdfb589 Mention the "lang" variable
Mikael Berthe <mikael@lilotux.net>
parents: 899
diff changeset
118 #set lang = en
1679
b2504df1c910 Update mcabberrc.example
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1628
diff changeset
119 #set help_dirs = "/usr/share/mcabber/help;~/share/mcabber/help"
b2504df1c910 Update mcabberrc.example
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1628
diff changeset
120 #set help_to_current = 0
919
653c1cdfb589 Mention the "lang" variable
Mikael Berthe <mikael@lilotux.net>
parents: 899
diff changeset
121
1206
abc5847d1613 Add Aspell options to the config. file
Mikael Berthe <mikael@lilotux.net>
parents: 1204
diff changeset
122 # Aspell
abc5847d1613 Add Aspell options to the config. file
Mikael Berthe <mikael@lilotux.net>
parents: 1204
diff changeset
123 # If your mcabber has been built with Aspell support, you can enable spell
abc5847d1613 Add Aspell options to the config. file
Mikael Berthe <mikael@lilotux.net>
parents: 1204
diff changeset
124 # checking with the following options (you can't change them once mcabber is
abc5847d1613 Add Aspell options to the config. file
Mikael Berthe <mikael@lilotux.net>
parents: 1204
diff changeset
125 # running).
1590
8d1bcc83ae32 Add support for spellchecking with Enchant (caolan)
Mikael Berthe <mikael@lilotux.net>
parents: 1585
diff changeset
126 #set spell_enable = 1
2170
282531385f34 Multilanguage spell checking
Dmitry Potapov <potapov.d@gmail.com>
parents: 2148
diff changeset
127 #set spell_lang = en_US ru_RU
1590
8d1bcc83ae32 Add support for spellchecking with Enchant (caolan)
Mikael Berthe <mikael@lilotux.net>
parents: 1585
diff changeset
128 #set spell_encoding = iso8859-1
8d1bcc83ae32 Add support for spellchecking with Enchant (caolan)
Mikael Berthe <mikael@lilotux.net>
parents: 1585
diff changeset
129 #set spell_encoding = UTF-8
1206
abc5847d1613 Add Aspell options to the config. file
Mikael Berthe <mikael@lilotux.net>
parents: 1204
diff changeset
130
1127
fddf2fef7b83 Add option "cmdhistory_lines"
Mikael Berthe <mikael@lilotux.net>
parents: 1120
diff changeset
131 # History
fddf2fef7b83 Add option "cmdhistory_lines"
Mikael Berthe <mikael@lilotux.net>
parents: 1120
diff changeset
132 # Number of lines to remember for the command line history
fddf2fef7b83 Add option "cmdhistory_lines"
Mikael Berthe <mikael@lilotux.net>
parents: 1120
diff changeset
133 # (default: 0, unlimited).
fddf2fef7b83 Add option "cmdhistory_lines"
Mikael Berthe <mikael@lilotux.net>
parents: 1120
diff changeset
134 set cmdhistory_lines = 250
fddf2fef7b83 Add option "cmdhistory_lines"
Mikael Berthe <mikael@lilotux.net>
parents: 1120
diff changeset
135
1311
0dda8238af21 Implement "/roster display"
Mikael Berthe <mikael@lilotux.net>
parents: 1297
diff changeset
136 # You can set up a mask to filter buddies and display them according to
0dda8238af21 Implement "/roster display"
Mikael Berthe <mikael@lilotux.net>
parents: 1297
diff changeset
137 # their status. The mask should contain the shortcut letters of the
0dda8238af21 Implement "/roster display"
Mikael Berthe <mikael@lilotux.net>
parents: 1297
diff changeset
138 # status you want to see ([o]nline, [f]ree_for_chat, [d]o_not_disturb,
0dda8238af21 Implement "/roster display"
Mikael Berthe <mikael@lilotux.net>
parents: 1297
diff changeset
139 # [n]ot_available, [a]way, [_]offline).
0dda8238af21 Implement "/roster display"
Mikael Berthe <mikael@lilotux.net>
parents: 1297
diff changeset
140 # For example, to display everybody the filter should be "ofdna_" (default).
0dda8238af21 Implement "/roster display"
Mikael Berthe <mikael@lilotux.net>
parents: 1297
diff changeset
141 # To display only the connected buddies, use "ofdna".
0dda8238af21 Implement "/roster display"
Mikael Berthe <mikael@lilotux.net>
parents: 1297
diff changeset
142 # Please note that this option is only used at startup (once mcabber is
1318
cb49b9a59bcf Fix double typo in rc file
Mikael Berthe <mikael@lilotux.net>
parents: 1313
diff changeset
143 # running you can use "/roster display").
1311
0dda8238af21 Implement "/roster display"
Mikael Berthe <mikael@lilotux.net>
parents: 1297
diff changeset
144 #set roster_display_filter = ofdna_
62
db2a1826bafa [/trunk] Changeset 77 by mikael
mikael
parents:
diff changeset
145
2009
a859ed648638 Replace the option « no_space_before_items » with « roster_no_leading_space ».
Simon Jacquin <simon@jacquin.me>
parents: 2007 2006
diff changeset
146 # By default, mcabber adds a leading space before each buddy in the roster. You
a859ed648638 Replace the option « no_space_before_items » with « roster_no_leading_space ».
Simon Jacquin <simon@jacquin.me>
parents: 2007 2006
diff changeset
147 # can remove it to gain a little space.
a859ed648638 Replace the option « no_space_before_items » with « roster_no_leading_space ».
Simon Jacquin <simon@jacquin.me>
parents: 2007 2006
diff changeset
148 #set roster_no_leading_space = 0
2007
6c02ccb14c1c Added an option to remove the extra space before items in the roster.
Simon Jacquin <simon@jacquin.me>
parents: 2000
diff changeset
149
1926
c1f9a4d47e05 Add option 'completion_ignore_case'
Mikael Berthe <mikael@lilotux.net>
parents: 1839
diff changeset
150 # By default command line completion is case-sensitive; this can be changed
c1f9a4d47e05 Add option 'completion_ignore_case'
Mikael Berthe <mikael@lilotux.net>
parents: 1839
diff changeset
151 # by setting the option 'completion_ignore_case' to 1.
c1f9a4d47e05 Add option 'completion_ignore_case'
Mikael Berthe <mikael@lilotux.net>
parents: 1839
diff changeset
152 #set completion_ignore_case = 0
c1f9a4d47e05 Add option 'completion_ignore_case'
Mikael Berthe <mikael@lilotux.net>
parents: 1839
diff changeset
153
2148
7a0df2e5da19 Add the 'carbons' option to mcabberrc.example
Mikael Berthe <mikael@lilotux.net>
parents: 2123
diff changeset
154 # Message Carbons (XEP-0280)
7a0df2e5da19 Add the 'carbons' option to mcabberrc.example
Mikael Berthe <mikael@lilotux.net>
parents: 2123
diff changeset
155 # If you want to enable Message Carbons at startup (and if your server
7a0df2e5da19 Add the 'carbons' option to mcabberrc.example
Mikael Berthe <mikael@lilotux.net>
parents: 2123
diff changeset
156 # supports them), set the 'carbons' option to 1. Default is 0.
7a0df2e5da19 Add the 'carbons' option to mcabberrc.example
Mikael Berthe <mikael@lilotux.net>
parents: 2123
diff changeset
157 #set carbons = 1
7a0df2e5da19 Add the 'carbons' option to mcabberrc.example
Mikael Berthe <mikael@lilotux.net>
parents: 2123
diff changeset
158
2190
ee3a40ffcd8b New option: 'clear_unread_on_carbon'
Holger Weiß <holger@zedat.fu-berlin.de>
parents: 2172
diff changeset
159 # Set the 'clear_unread_on_carbon' option to 1 if the unread messages flag
ee3a40ffcd8b New option: 'clear_unread_on_carbon'
Holger Weiß <holger@zedat.fu-berlin.de>
parents: 2172
diff changeset
160 # should be cleared when an outgoing copy of a message sent to that contact
2236
41e897b79c8d Add a default value to mcabberrc.example comments
Mikael Berthe <mikael@lilotux.net>
parents: 2234
diff changeset
161 # is received from another client. Default is 0.
2190
ee3a40ffcd8b New option: 'clear_unread_on_carbon'
Holger Weiß <holger@zedat.fu-berlin.de>
parents: 2172
diff changeset
162 #set clear_unread_on_carbon = 1
ee3a40ffcd8b New option: 'clear_unread_on_carbon'
Holger Weiß <holger@zedat.fu-berlin.de>
parents: 2172
diff changeset
163
1714
db15031d5779 s/JEP/XEP/
Mikael Berthe <mikael@lilotux.net>
parents: 1713
diff changeset
164 # Typing notifications, Chat States, Events (XEP-22/85)
993
0759f4c7da68 Add option 'disable_chatstates'
Mikael Berthe <mikael@lilotux.net>
parents: 983
diff changeset
165 # Set disable_chatstates to 1 if you don't want to use typing notifications.
0759f4c7da68 Add option 'disable_chatstates'
Mikael Berthe <mikael@lilotux.net>
parents: 983
diff changeset
166 # Note: changing this option once mcabber is running has no effect.
0759f4c7da68 Add option 'disable_chatstates'
Mikael Berthe <mikael@lilotux.net>
parents: 983
diff changeset
167 #set disable_chatstates = 0
0759f4c7da68 Add option 'disable_chatstates'
Mikael Berthe <mikael@lilotux.net>
parents: 983
diff changeset
168
113
8ac67e951eab [/trunk] Changeset 127 by mikael
mikael
parents: 87
diff changeset
169 # History logging
8ac67e951eab [/trunk] Changeset 127 by mikael
mikael
parents: 87
diff changeset
170 # You can save the messages history: set logging = 1
1144
b8f5fe2d666a Add option "logging_ignore_status"
Mikael Berthe <mikael@lilotux.net>
parents: 1141
diff changeset
171 # Set 'logging_ignore_status' to 1 if you do not want to save status changes
b8f5fe2d666a Add option "logging_ignore_status"
Mikael Berthe <mikael@lilotux.net>
parents: 1141
diff changeset
172 # (and status messages) to the log files (default: 0).
177
a51ce78a0e2a [/trunk] Changeset 189 by mikael
mikael
parents: 169
diff changeset
173 # You can load (read) the messages history: set load_logs = 1
899
a833f3d6119a Add option 'max_history_age'
Mikael Berthe <mikael@lilotux.net>
parents: 837
diff changeset
174 # If you enable load_logs, you can use the 'max_history_age' setting below.
2207
3a4a3a180c9c Minor documentation update
Mikael Berthe <mikael@lilotux.net>
parents: 2201
diff changeset
175 # The default logging directory (logging_dir) is $HOME/.mcabber/histo/
3a4a3a180c9c Minor documentation update
Mikael Berthe <mikael@lilotux.net>
parents: 2201
diff changeset
176 # (or $XDG_CONFIG_HOME/mcabber/histo/).
356
a30ca1b77fa2 Disable logging by default in the sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 355
diff changeset
177 # Defaults for logging, load_logs are 0 (disabled)
376
d37d8d661115 Update mcabberrc.example
Mikael Berthe <mikael@lilotux.net>
parents: 374
diff changeset
178 # Note: the logging directory must exist if you enable logging, mcabber
d37d8d661115 Update mcabberrc.example
Mikael Berthe <mikael@lilotux.net>
parents: 374
diff changeset
179 # will not create it.
1141
5be2408a6534 Add option "max_history_blocks"
Mikael Berthe <mikael@lilotux.net>
parents: 1136
diff changeset
180 # Note: these options, except 'max_history_age' and 'max_history_blocks',
5be2408a6534 Add option "max_history_blocks"
Mikael Berthe <mikael@lilotux.net>
parents: 1136
diff changeset
181 # are used at startup time.
356
a30ca1b77fa2 Disable logging by default in the sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 355
diff changeset
182 #set logging = 1
334
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
183 #set load_logs = 1
1167
9726c78a91f3 Allow '~' (HOME directory) in config options
Mikael Berthe <mikael@lilotux.net>
parents: 1166
diff changeset
184 #set logging_dir = ~/.mcabber/histo/
1144
b8f5fe2d666a Add option "logging_ignore_status"
Mikael Berthe <mikael@lilotux.net>
parents: 1141
diff changeset
185 #set logging_ignore_status = 1
160
44c6410b4845 [/trunk] Changeset 172 by mikael
mikael
parents: 139
diff changeset
186
477
d11e5ce2582c Improve hk_message_in()
Mikael Berthe <mikael@lilotux.net>
parents: 453
diff changeset
187 # Set log_muc_conf to 1 to enable MUC chatrooms logging (default = 0)
635
d4119cb85aeb New "load_muc_logs" option
Mikael Berthe <mikael@lilotux.net>
parents: 619
diff changeset
188 #set log_muc_conf = 1
d4119cb85aeb New "load_muc_logs" option
Mikael Berthe <mikael@lilotux.net>
parents: 619
diff changeset
189 # Set load_muc_logs to 1 to read MUC chatrooms logs (default = 0). These
d4119cb85aeb New "load_muc_logs" option
Mikael Berthe <mikael@lilotux.net>
parents: 619
diff changeset
190 # logs will be displayed in the buffer window _before_ any history received
d4119cb85aeb New "load_muc_logs" option
Mikael Berthe <mikael@lilotux.net>
parents: 619
diff changeset
191 # from the server.
d4119cb85aeb New "load_muc_logs" option
Mikael Berthe <mikael@lilotux.net>
parents: 619
diff changeset
192 #set load_muc_logs = 0
477
d11e5ce2582c Improve hk_message_in()
Mikael Berthe <mikael@lilotux.net>
parents: 453
diff changeset
193
899
a833f3d6119a Add option 'max_history_age'
Mikael Berthe <mikael@lilotux.net>
parents: 837
diff changeset
194 # When load_logs (or load_muc_logs) is enabled, you can specify a maximum
a833f3d6119a Add option 'max_history_age'
Mikael Berthe <mikael@lilotux.net>
parents: 837
diff changeset
195 # number of history days to load into memory with max_history_age.
a833f3d6119a Add option 'max_history_age'
Mikael Berthe <mikael@lilotux.net>
parents: 837
diff changeset
196 # Default = 0 (disabled -- everything is loaded)
a833f3d6119a Add option 'max_history_age'
Mikael Berthe <mikael@lilotux.net>
parents: 837
diff changeset
197 # Note: this option is only used when reading history files, not later.
a833f3d6119a Add option 'max_history_age'
Mikael Berthe <mikael@lilotux.net>
parents: 837
diff changeset
198 #set max_history_age = 0
1437
071c8170b7de Add option 'statefile' to keep track of unread messages across restarts
Mikael Berthe <mikael@lilotux.net>
parents: 1427
diff changeset
199
071c8170b7de Add option 'statefile' to keep track of unread messages across restarts
Mikael Berthe <mikael@lilotux.net>
parents: 1427
diff changeset
200 # mcabber can store the list of unread messages in a state file,
071c8170b7de Add option 'statefile' to keep track of unread messages across restarts
Mikael Berthe <mikael@lilotux.net>
parents: 1427
diff changeset
201 # so that the message flags are set back at next startup.
071c8170b7de Add option 'statefile' to keep track of unread messages across restarts
Mikael Berthe <mikael@lilotux.net>
parents: 1427
diff changeset
202 # Note that 'logging' must be enabled for this feature to work.
071c8170b7de Add option 'statefile' to keep track of unread messages across restarts
Mikael Berthe <mikael@lilotux.net>
parents: 1427
diff changeset
203 #set statefile = ~/.mcabber/mcabber.state
071c8170b7de Add option 'statefile' to keep track of unread messages across restarts
Mikael Berthe <mikael@lilotux.net>
parents: 1427
diff changeset
204
1141
5be2408a6534 Add option "max_history_blocks"
Mikael Berthe <mikael@lilotux.net>
parents: 1136
diff changeset
205 # You can specify a maximum number of data blocks per buffer (1 block contains
5be2408a6534 Add option "max_history_blocks"
Mikael Berthe <mikael@lilotux.net>
parents: 1136
diff changeset
206 # about 8kB). The default is 0 (unlimited). If set, this value must be > 2.
1757
6e55f9776d5d Uncomment max_history_blocks in the sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1756
diff changeset
207 set max_history_blocks = 8
899
a833f3d6119a Add option 'max_history_age'
Mikael Berthe <mikael@lilotux.net>
parents: 837
diff changeset
208
619
44ddf9bec3a5 Answer IQ:version & IQ:time requests
Mikael Berthe <mikael@lilotux.net>
parents: 550
diff changeset
209 # IQ settings
44ddf9bec3a5 Answer IQ:version & IQ:time requests
Mikael Berthe <mikael@lilotux.net>
parents: 550
diff changeset
210 # Set iq_version_hide_os to 1 if you do not want to allow people to retrieve
899
a833f3d6119a Add option 'max_history_age'
Mikael Berthe <mikael@lilotux.net>
parents: 837
diff changeset
211 # your OS version.
619
44ddf9bec3a5 Answer IQ:version & IQ:time requests
Mikael Berthe <mikael@lilotux.net>
parents: 550
diff changeset
212 #set iq_version_hide_os = 0
1254
401639413340 More jabber:iq:last support... (misc)
Mikael Berthe <mikael@lilotux.net>
parents: 1207
diff changeset
213 #
2066
69699ba3010f Add 'iq_version_hide', 'iq_version_hide_version'
Mikael Berthe <mikael@lilotux.net>
parents: 2065
diff changeset
214 # Set iq_version_hide_version to 1 if you do not want to allow people to
69699ba3010f Add 'iq_version_hide', 'iq_version_hide_version'
Mikael Berthe <mikael@lilotux.net>
parents: 2065
diff changeset
215 # retrieve your mcabber version.
69699ba3010f Add 'iq_version_hide', 'iq_version_hide_version'
Mikael Berthe <mikael@lilotux.net>
parents: 2065
diff changeset
216 #set iq_version_hide_version = 0
69699ba3010f Add 'iq_version_hide', 'iq_version_hide_version'
Mikael Berthe <mikael@lilotux.net>
parents: 2065
diff changeset
217 #
2067
79659eb4f66f Rename 'iq_version_hide_time' to 'iq_time_hide'
Mikael Berthe <mikael@lilotux.net>
parents: 2066
diff changeset
218 # Set iq_time_hide to 1 if you do not want to allow people to retrieve
2065
c09fc3834c69 Add option 'iq_version_hide_time'
Mikael Berthe <mikael@lilotux.net>
parents: 2028
diff changeset
219 # your OS time.
2067
79659eb4f66f Rename 'iq_version_hide_time' to 'iq_time_hide'
Mikael Berthe <mikael@lilotux.net>
parents: 2066
diff changeset
220 #set iq_time_hide = 0
2065
c09fc3834c69 Add option 'iq_version_hide_time'
Mikael Berthe <mikael@lilotux.net>
parents: 2028
diff changeset
221 #
1254
401639413340 More jabber:iq:last support... (misc)
Mikael Berthe <mikael@lilotux.net>
parents: 1207
diff changeset
222 # Set iq_last_disable to 1 if you want to disable response to jabber:iq:last
1261
704adf4df2d0 Send service-unavailable when Last Activity is disabled
Mikael Berthe <mikael@lilotux.net>
parents: 1254
diff changeset
223 # queries (XEP-0012). Set iq_last_disable_when_notavail to 1 if you want
704adf4df2d0 Send service-unavailable when Last Activity is disabled
Mikael Berthe <mikael@lilotux.net>
parents: 1254
diff changeset
224 # to disable Last Activity reports only when the not-available status is set.
704adf4df2d0 Send service-unavailable when Last Activity is disabled
Mikael Berthe <mikael@lilotux.net>
parents: 1254
diff changeset
225 # (Default is 0 for both options)
1254
401639413340 More jabber:iq:last support... (misc)
Mikael Berthe <mikael@lilotux.net>
parents: 1207
diff changeset
226 #set iq_last_disable = 0
1263
d1a111f39b7a Fix typo in mcabberrc sample file
Mikael Berthe <mikael@lilotux.net>
parents: 1261
diff changeset
227 #set iq_last_disable_when_notavail = 1
1498
2eaa52d314e3 Add option 'iq_hide_requests'
Mikael Berthe <mikael@lilotux.net>
parents: 1496
diff changeset
228 #
2eaa52d314e3 Add option 'iq_hide_requests'
Mikael Berthe <mikael@lilotux.net>
parents: 1496
diff changeset
229 # Set iq_hide_requests to 1 if you don't want received IQ requests to be
2eaa52d314e3 Add option 'iq_hide_requests'
Mikael Berthe <mikael@lilotux.net>
parents: 1496
diff changeset
230 # displayed in the status window (default: 0).
2eaa52d314e3 Add option 'iq_hide_requests'
Mikael Berthe <mikael@lilotux.net>
parents: 1496
diff changeset
231 #set iq_hide_requests = 1
619
44ddf9bec3a5 Answer IQ:version & IQ:time requests
Mikael Berthe <mikael@lilotux.net>
parents: 550
diff changeset
232
1622
90ecb027d1e3 Add modules_dir to example mcabberrc
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1616
diff changeset
233 # Modules
1628
a8a3d404ccce Cosmetic changes
Mikael Berthe <mikael@lilotux.net>
parents: 1622
diff changeset
234 # If mcabber is built with modules support, you can specify the path
1679
b2504df1c910 Update mcabberrc.example
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1628
diff changeset
235 # to the directory where your modules reside. Though, default compiled-in
b2504df1c910 Update mcabberrc.example
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1628
diff changeset
236 # value should be appropriate.
1622
90ecb027d1e3 Add modules_dir to example mcabberrc
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1616
diff changeset
237 #set modules_dir = /usr/lib/mcabber/
90ecb027d1e3 Add modules_dir to example mcabberrc
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1616
diff changeset
238
675
ae7016aae014 New "beep_on_message" option
Mikael Berthe <mikael@lilotux.net>
parents: 659
diff changeset
239 # Beep
ae7016aae014 New "beep_on_message" option
Mikael Berthe <mikael@lilotux.net>
parents: 659
diff changeset
240 # Set beep_on_message to 1 if you want mcabber to beep when receiving
ae7016aae014 New "beep_on_message" option
Mikael Berthe <mikael@lilotux.net>
parents: 659
diff changeset
241 # a new message (except in chatrooms). If you want a more sophisticated
ae7016aae014 New "beep_on_message" option
Mikael Berthe <mikael@lilotux.net>
parents: 659
diff changeset
242 # system (e.g. play a sound), have a look at 'events_command' below.
ae7016aae014 New "beep_on_message" option
Mikael Berthe <mikael@lilotux.net>
parents: 659
diff changeset
243 #set beep_on_message = 0
ae7016aae014 New "beep_on_message" option
Mikael Berthe <mikael@lilotux.net>
parents: 659
diff changeset
244
160
44c6410b4845 [/trunk] Changeset 172 by mikael
mikael
parents: 139
diff changeset
245 # External command for events
44c6410b4845 [/trunk] Changeset 172 by mikael
mikael
parents: 139
diff changeset
246 # You can specify a script or process to be launched when an event occurs.
1129
1a109ebf3f24 Add option "events_ignore_active_window"
Mikael Berthe <mikael@lilotux.net>
parents: 1127
diff changeset
247 # Set 'events_ignore_active_window' to 1 if you don't want the script to
1a109ebf3f24 Add option "events_ignore_active_window"
Mikael Berthe <mikael@lilotux.net>
parents: 1127
diff changeset
248 # be run for a message to the current active window (default: 0).
525
c7f94f6e51f0 Update sample mcabberrc and eventcmd script
Mikael Berthe <mikael@lilotux.net>
parents: 522
diff changeset
249 #
c7f94f6e51f0 Update sample mcabberrc and eventcmd script
Mikael Berthe <mikael@lilotux.net>
parents: 522
diff changeset
250 # 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
251 # 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
252 # 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
253 # 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
254 # 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
255 # 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
256 #
355
c5a7a7273986 Add some external actions
Mikael Berthe <mikael@lilotux.net>
parents: 339
diff changeset
257 # The command is called the following way:
525
c7f94f6e51f0 Update sample mcabberrc and eventcmd script
Mikael Berthe <mikael@lilotux.net>
parents: 522
diff changeset
258 # $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
259 # $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
260 # $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
261 # $events_command STATUS X jabber@id (new buddy status is X)
1839
f0a07658e009 Update UNREAD event data
Mikael Berthe <mikael@lilotux.net>
parents: 1793
diff changeset
262 # $events_command UNREAD "N x y z" (number of unread buddy buffers)
f0a07658e009 Update UNREAD event data
Mikael Berthe <mikael@lilotux.net>
parents: 1793
diff changeset
263 # (x=attention y=muc unread buffers z=muc unread buffers with attention sign)
355
c5a7a7273986 Add some external actions
Mikael Berthe <mikael@lilotux.net>
parents: 339
diff changeset
264 # See sample script in contrib/ directory.
1167
9726c78a91f3 Allow '~' (HOME directory) in config options
Mikael Berthe <mikael@lilotux.net>
parents: 1166
diff changeset
265 #set events_command = ~/.mcabber/eventcmd
525
c7f94f6e51f0 Update sample mcabberrc and eventcmd script
Mikael Berthe <mikael@lilotux.net>
parents: 522
diff changeset
266 #
1129
1a109ebf3f24 Add option "events_ignore_active_window"
Mikael Berthe <mikael@lilotux.net>
parents: 1127
diff changeset
267 #set events_ignore_active_window = 0
1a109ebf3f24 Add option "events_ignore_active_window"
Mikael Berthe <mikael@lilotux.net>
parents: 1127
diff changeset
268 #
525
c7f94f6e51f0 Update sample mcabberrc and eventcmd script
Mikael Berthe <mikael@lilotux.net>
parents: 522
diff changeset
269 #set event_log_files = 0
1167
9726c78a91f3 Allow '~' (HOME directory) in config options
Mikael Berthe <mikael@lilotux.net>
parents: 1166
diff changeset
270 #set event_log_dir = ~/.mcabber/event_files
113
8ac67e951eab [/trunk] Changeset 127 by mikael
mikael
parents: 87
diff changeset
271
1447
ba706e97d6ec Add option 'eventcmd_use_nickname'
Mikael Berthe <mikael@lilotux.net>
parents: 1446
diff changeset
272 # If you set 'eventcmd_use_nickname' to 1, mcabber will pass the nickname
ba706e97d6ec Add option 'eventcmd_use_nickname'
Mikael Berthe <mikael@lilotux.net>
parents: 1446
diff changeset
273 # (if it is defined) to the event script instead of the JID (default: 0).
ba706e97d6ec Add option 'eventcmd_use_nickname'
Mikael Berthe <mikael@lilotux.net>
parents: 1446
diff changeset
274 #set eventcmd_use_nickname = 0
ba706e97d6ec Add option 'eventcmd_use_nickname'
Mikael Berthe <mikael@lilotux.net>
parents: 1446
diff changeset
275
676
80d4959422ca New "eventcmd_checkstatus" option
Mikael Berthe <mikael@lilotux.net>
parents: 675
diff changeset
276 # External command status check
80d4959422ca New "eventcmd_checkstatus" option
Mikael Berthe <mikael@lilotux.net>
parents: 675
diff changeset
277 # You can request mcabber to inspect exit status value after each
80d4959422ca New "eventcmd_checkstatus" option
Mikael Berthe <mikael@lilotux.net>
parents: 675
diff changeset
278 # events_command. If this option is set, mcabber will beep if the
80d4959422ca New "eventcmd_checkstatus" option
Mikael Berthe <mikael@lilotux.net>
parents: 675
diff changeset
279 # exit value is 2.
80d4959422ca New "eventcmd_checkstatus" option
Mikael Berthe <mikael@lilotux.net>
parents: 675
diff changeset
280 #set eventcmd_checkstatus = 0
80d4959422ca New "eventcmd_checkstatus" option
Mikael Berthe <mikael@lilotux.net>
parents: 675
diff changeset
281
1353
7caedca15e50 Add post-connect internal hook
Mikael Berthe <mikael@lilotux.net>
parents: 1348
diff changeset
282 # Internal hooks
7caedca15e50 Add post-connect internal hook
Mikael Berthe <mikael@lilotux.net>
parents: 1348
diff changeset
283 # You can ask mcabber to execute an internal command when a special event
7caedca15e50 Add post-connect internal hook
Mikael Berthe <mikael@lilotux.net>
parents: 1348
diff changeset
284 # occurs (for example when it connects to the server).
7caedca15e50 Add post-connect internal hook
Mikael Berthe <mikael@lilotux.net>
parents: 1348
diff changeset
285 #
7caedca15e50 Add post-connect internal hook
Mikael Berthe <mikael@lilotux.net>
parents: 1348
diff changeset
286 # 'hook-post-connect' is executed when mcabber has connected to the server
7caedca15e50 Add post-connect internal hook
Mikael Berthe <mikael@lilotux.net>
parents: 1348
diff changeset
287 # and the roster has been received.
7caedca15e50 Add post-connect internal hook
Mikael Berthe <mikael@lilotux.net>
parents: 1348
diff changeset
288 #set hook-post-connect = status dnd
1354
c373ff3fe7e1 Add pre-disconnect internal hook
Mikael Berthe <mikael@lilotux.net>
parents: 1353
diff changeset
289 #
c373ff3fe7e1 Add pre-disconnect internal hook
Mikael Berthe <mikael@lilotux.net>
parents: 1353
diff changeset
290 # 'hook-pre-disconnect' is executed just before mcabber disconnects from
c373ff3fe7e1 Add pre-disconnect internal hook
Mikael Berthe <mikael@lilotux.net>
parents: 1353
diff changeset
291 # the server.
c373ff3fe7e1 Add pre-disconnect internal hook
Mikael Berthe <mikael@lilotux.net>
parents: 1353
diff changeset
292 #set hook-pre-disconnect = say_to foo@bar Goodbye!
1353
7caedca15e50 Add post-connect internal hook
Mikael Berthe <mikael@lilotux.net>
parents: 1348
diff changeset
293
1426
a64778f5f26b Implement FIFO named command pipe
Mikael Berthe <mikael@lilotux.net>
parents: 1419
diff changeset
294 # FIFO
a64778f5f26b Implement FIFO named command pipe
Mikael Berthe <mikael@lilotux.net>
parents: 1419
diff changeset
295 # mcabber can create a FIFO named pipe and listen to this pipe for commands.
1944
098b7b5b4854 Add a comment about the FIFO module to the sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1943
diff changeset
296 # Don't forget to load the FIFO module if you plan to use this feature!
1490
9d5a2f45addb Remove obsolete note in the configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1482
diff changeset
297 # Default: disabled.
1526
eefa0ae248d8 Add option "fifo_ignore" (Suggested by T. Glaser)
Mikael Berthe <mikael@lilotux.net>
parents: 1520
diff changeset
298 # Set 'fifo_hide_commands' to 1 if you don't want to see the FIFO commands
1427
a8eb9aba2ed2 Add option 'fifo_hide_commands'
Mikael Berthe <mikael@lilotux.net>
parents: 1426
diff changeset
299 # in the log window (they will still be written to the tracelog file).
1526
eefa0ae248d8 Add option "fifo_ignore" (Suggested by T. Glaser)
Mikael Berthe <mikael@lilotux.net>
parents: 1520
diff changeset
300 # When FIFO is configured, you can turn it off and on in real time with
eefa0ae248d8 Add option "fifo_ignore" (Suggested by T. Glaser)
Mikael Berthe <mikael@lilotux.net>
parents: 1520
diff changeset
301 # the 'fifo_ignore' option (default: 0). When set to 1, the FIFO input is
eefa0ae248d8 Add option "fifo_ignore" (Suggested by T. Glaser)
Mikael Berthe <mikael@lilotux.net>
parents: 1520
diff changeset
302 # still read but it is discarded.
1426
a64778f5f26b Implement FIFO named command pipe
Mikael Berthe <mikael@lilotux.net>
parents: 1419
diff changeset
303 #set fifo_name = ~/.mcabber/mcabber.fifo
1427
a8eb9aba2ed2 Add option 'fifo_hide_commands'
Mikael Berthe <mikael@lilotux.net>
parents: 1426
diff changeset
304 #set fifo_hide_commands = 0
1526
eefa0ae248d8 Add option "fifo_ignore" (Suggested by T. Glaser)
Mikael Berthe <mikael@lilotux.net>
parents: 1520
diff changeset
305 #set fifo_ignore = 0
1944
098b7b5b4854 Add a comment about the FIFO module to the sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1943
diff changeset
306 #
098b7b5b4854 Add a comment about the FIFO module to the sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1943
diff changeset
307 #module load fifo
1426
a64778f5f26b Implement FIFO named command pipe
Mikael Berthe <mikael@lilotux.net>
parents: 1419
diff changeset
308
1974
acbebd68c7f0 Modularize url_regex
Mikael Berthe <mikael@lilotux.net>
parents: 1960
diff changeset
309 # URL extractor
acbebd68c7f0 Modularize url_regex
Mikael Berthe <mikael@lilotux.net>
parents: 1960
diff changeset
310 # Set 'url_regex' to a regular expression matching urls. If it matches an
acbebd68c7f0 Modularize url_regex
Mikael Berthe <mikael@lilotux.net>
parents: 1960
diff changeset
311 # url in an incoming messages, it'll print it to the log window.
acbebd68c7f0 Modularize url_regex
Mikael Berthe <mikael@lilotux.net>
parents: 1960
diff changeset
312 # Don't forget to load the urlregex module if you plan to use this feature!
acbebd68c7f0 Modularize url_regex
Mikael Berthe <mikael@lilotux.net>
parents: 1960
diff changeset
313 #set url_regex = "(((https?|ftps?|nntp)://)|www[.][-a-z0-9.]+|(mailto:|news:))(%[0-9A-F]{2}|[-_.!~*';/?:@&=+$,#[:alnum:]])+"
acbebd68c7f0 Modularize url_regex
Mikael Berthe <mikael@lilotux.net>
parents: 1960
diff changeset
314 #
acbebd68c7f0 Modularize url_regex
Mikael Berthe <mikael@lilotux.net>
parents: 1960
diff changeset
315 #module load urlregex
acbebd68c7f0 Modularize url_regex
Mikael Berthe <mikael@lilotux.net>
parents: 1960
diff changeset
316
acbebd68c7f0 Modularize url_regex
Mikael Berthe <mikael@lilotux.net>
parents: 1960
diff changeset
317
374
bd5638c21834 Improve logging system (traces)
Mikael Berthe <mikael@lilotux.net>
parents: 364
diff changeset
318 # Traces logging
bd5638c21834 Improve logging system (traces)
Mikael Berthe <mikael@lilotux.net>
parents: 364
diff changeset
319 # If you want advanced traces, please specify a file and a level here.
1734
eae4a2637f2c Fix small typo in config. file
Mikael Berthe <mikael@lilotux.net>
parents: 1714
diff changeset
320 # There are currently 4 tracelog levels:
374
bd5638c21834 Improve logging system (traces)
Mikael Berthe <mikael@lilotux.net>
parents: 364
diff changeset
321 # lvl 1: most events of the log window are written to the file
1616
4c7104ec5f3b Add 2 debugging levels (for 'tracelog_level')
Mikael Berthe <mikael@lilotux.net>
parents: 1610
diff changeset
322 # lvl 2: Loudmouth verbose logging
4c7104ec5f3b Add 2 debugging levels (for 'tracelog_level')
Mikael Berthe <mikael@lilotux.net>
parents: 1610
diff changeset
323 # lvl 3: debug logging (XML, etc.)
4c7104ec5f3b Add 2 debugging levels (for 'tracelog_level')
Mikael Berthe <mikael@lilotux.net>
parents: 1610
diff changeset
324 # lvl 4: noisy debug logging (Loudmouth parser...)
374
bd5638c21834 Improve logging system (traces)
Mikael Berthe <mikael@lilotux.net>
parents: 364
diff changeset
325 # Default is level 0, no trace logging
bd5638c21834 Improve logging system (traces)
Mikael Berthe <mikael@lilotux.net>
parents: 364
diff changeset
326 #set tracelog_level = 1
1167
9726c78a91f3 Allow '~' (HOME directory) in config options
Mikael Berthe <mikael@lilotux.net>
parents: 1166
diff changeset
327 #set tracelog_file = ~/.mcabber/mcabber.log
113
8ac67e951eab [/trunk] Changeset 127 by mikael
mikael
parents: 87
diff changeset
328
525
c7f94f6e51f0 Update sample mcabberrc and eventcmd script
Mikael Berthe <mikael@lilotux.net>
parents: 522
diff changeset
329 # 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
330 # 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
331 # (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
332 # 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
333 # See 'message_autoaway' below.
c7f94f6e51f0 Update sample mcabberrc and eventcmd script
Mikael Berthe <mikael@lilotux.net>
parents: 522
diff changeset
334 #set autoaway = 0
c7f94f6e51f0 Update sample mcabberrc and eventcmd script
Mikael Berthe <mikael@lilotux.net>
parents: 522
diff changeset
335
819
c2d7d9dd4193 New option 'block_unsubscribed'
Mikael Berthe <mikael@lilotux.net>
parents: 808
diff changeset
336 # Message blocking
823
19c615fd071e New option "delete_on_reject"
Mikael Berthe <mikael@lilotux.net>
parents: 819
diff changeset
337 # Set 'block_unsubscribed' to 1 if you want to block (drop) incoming
819
c2d7d9dd4193 New option 'block_unsubscribed'
Mikael Berthe <mikael@lilotux.net>
parents: 808
diff changeset
338 # messages from people you haven't authorized. (default: 0)
c2d7d9dd4193 New option 'block_unsubscribed'
Mikael Berthe <mikael@lilotux.net>
parents: 808
diff changeset
339 #set block_unsubscribed = 0
823
19c615fd071e New option "delete_on_reject"
Mikael Berthe <mikael@lilotux.net>
parents: 819
diff changeset
340 #
19c615fd071e New option "delete_on_reject"
Mikael Berthe <mikael@lilotux.net>
parents: 819
diff changeset
341 # Set 'delete_on_reject' to 1 if you want to delete buddies from your
19c615fd071e New option "delete_on_reject"
Mikael Berthe <mikael@lilotux.net>
parents: 819
diff changeset
342 # roster when you reject their subscription request. (default: 0)
19c615fd071e New option "delete_on_reject"
Mikael Berthe <mikael@lilotux.net>
parents: 819
diff changeset
343 # (See documentation for /event)
19c615fd071e New option "delete_on_reject"
Mikael Berthe <mikael@lilotux.net>
parents: 819
diff changeset
344 # The buddy is actually deleted only if there is no other subscription,
19c615fd071e New option "delete_on_reject"
Mikael Berthe <mikael@lilotux.net>
parents: 819
diff changeset
345 # so for example if you are subscribed to this buddy's presence updates it
19c615fd071e New option "delete_on_reject"
Mikael Berthe <mikael@lilotux.net>
parents: 819
diff changeset
346 # won't be deleted.
19c615fd071e New option "delete_on_reject"
Mikael Berthe <mikael@lilotux.net>
parents: 819
diff changeset
347 #set delete_on_reject = 0
819
c2d7d9dd4193 New option 'block_unsubscribed'
Mikael Berthe <mikael@lilotux.net>
parents: 808
diff changeset
348
837
7c74eef1d0e0 New option "muc_auto_whois"
Mikael Berthe <mikael@lilotux.net>
parents: 823
diff changeset
349 # MUC
1166
c4da23bf8958 Add option 'muc_flag_joins'
Mikael Berthe <mikael@lilotux.net>
parents: 1144
diff changeset
350 # Set 'muc_flag_joins' to 1 if you want the MUC rooms to be flagged in
c4da23bf8958 Add option 'muc_flag_joins'
Mikael Berthe <mikael@lilotux.net>
parents: 1144
diff changeset
351 # the roster when somebody joins a room. Set it to 2 if you want a flag
c4da23bf8958 Add option 'muc_flag_joins'
Mikael Berthe <mikael@lilotux.net>
parents: 1144
diff changeset
352 # for leaves too.
c4da23bf8958 Add option 'muc_flag_joins'
Mikael Berthe <mikael@lilotux.net>
parents: 1144
diff changeset
353 #set muc_flag_joins = 0
1377
cd9182f0b5c7 Add /room setopt {print_status,auto_whois}
Mikael Berthe <mikael@lilotux.net>
parents: 1354
diff changeset
354 # Set 'muc_print_status' to see status changes in MUC rooms:
cd9182f0b5c7 Add /room setopt {print_status,auto_whois}
Mikael Berthe <mikael@lilotux.net>
parents: 1354
diff changeset
355 # 1: (none) do not display joining/leaving members
cd9182f0b5c7 Add /room setopt {print_status,auto_whois}
Mikael Berthe <mikael@lilotux.net>
parents: 1354
diff changeset
356 # 2: (in_and_out) display joining/leaving members
cd9182f0b5c7 Add /room setopt {print_status,auto_whois}
Mikael Berthe <mikael@lilotux.net>
parents: 1354
diff changeset
357 # 3: (all) display joining/leaving members and member status changes
cd9182f0b5c7 Add /room setopt {print_status,auto_whois}
Mikael Berthe <mikael@lilotux.net>
parents: 1354
diff changeset
358 # (default: in_and_out)
cd9182f0b5c7 Add /room setopt {print_status,auto_whois}
Mikael Berthe <mikael@lilotux.net>
parents: 1354
diff changeset
359 #set muc_print_status = 2
837
7c74eef1d0e0 New option "muc_auto_whois"
Mikael Berthe <mikael@lilotux.net>
parents: 823
diff changeset
360 # Set 'muc_auto_whois' to 1 if you want to call /room whois each time
7c74eef1d0e0 New option "muc_auto_whois"
Mikael Berthe <mikael@lilotux.net>
parents: 823
diff changeset
361 # somebody joins a room. (default: 0)
7c74eef1d0e0 New option "muc_auto_whois"
Mikael Berthe <mikael@lilotux.net>
parents: 823
diff changeset
362 #set muc_auto_whois = 0
2006
fa6694a193ec Add configuration setting for previous commit
Hermitifier
parents: 2000
diff changeset
363 # Set 'muc_print_jid' to see real jid in non-anonynmous room when somebody
fa6694a193ec Add configuration setting for previous commit
Hermitifier
parents: 2000
diff changeset
364 # joins. This setting will be ignored when auto_whois is enabled.
fa6694a193ec Add configuration setting for previous commit
Hermitifier
parents: 2000
diff changeset
365 # 0: only nick (don't print jid even if available)
fa6694a193ec Add configuration setting for previous commit
Hermitifier
parents: 2000
diff changeset
366 # 1: nick and bare jid
fa6694a193ec Add configuration setting for previous commit
Hermitifier
parents: 2000
diff changeset
367 # 2: nick and full jid with resource
fa6694a193ec Add configuration setting for previous commit
Hermitifier
parents: 2000
diff changeset
368 #set muc_print_jid = 1
1207
8f0af3b88cef MUC: improve nickname detection and add option 'muc_disable_nick_hl'
Mikael Berthe <mikael@lilotux.net>
parents: 1206
diff changeset
369 #
8f0af3b88cef MUC: improve nickname detection and add option 'muc_disable_nick_hl'
Mikael Berthe <mikael@lilotux.net>
parents: 1206
diff changeset
370 # Set 'muc_disable_nick_hl' to 1 if you don't want mcabber to color lines
8f0af3b88cef MUC: improve nickname detection and add option 'muc_disable_nick_hl'
Mikael Berthe <mikael@lilotux.net>
parents: 1206
diff changeset
371 # containing your nickname in a MUC room.
8f0af3b88cef MUC: improve nickname detection and add option 'muc_disable_nick_hl'
Mikael Berthe <mikael@lilotux.net>
parents: 1206
diff changeset
372 #set muc_disable_nick_hl = 0
1756
e2c084204583 Add (optional) suffix after nick completion in Multi-User Chats
Mikael Berthe <mikael@lilotux.net>
parents: 1734
diff changeset
373 #
1793
c3ddb52f1055 Rename completion_muc_suffix to muc_completion_suffix
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1757
diff changeset
374 # Set 'muc_completion_suffix' if you want mcabber to append a string to
1756
e2c084204583 Add (optional) suffix after nick completion in Multi-User Chats
Mikael Berthe <mikael@lilotux.net>
parents: 1734
diff changeset
375 # suggested nicknames (only at the beginning of a line), like ":" or ",".
e2c084204583 Add (optional) suffix after nick completion in Multi-User Chats
Mikael Berthe <mikael@lilotux.net>
parents: 1734
diff changeset
376 # (Default: none)
1793
c3ddb52f1055 Rename completion_muc_suffix to muc_completion_suffix
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1757
diff changeset
377 #set muc_completion_suffix = ": "
1980
3bcc57751283 Add 'muc_bookmark_autoupdate' (Hermitifier)
Mikael Berthe <mikael@lilotux.net>
parents: 1974
diff changeset
378 #
3bcc57751283 Add 'muc_bookmark_autoupdate' (Hermitifier)
Mikael Berthe <mikael@lilotux.net>
parents: 1974
diff changeset
379 # Set 'muc_bookmark_autoupdate' to 1 if you want changes made to room options
3bcc57751283 Add 'muc_bookmark_autoupdate' (Hermitifier)
Mikael Berthe <mikael@lilotux.net>
parents: 1974
diff changeset
380 # be stored automatically on server. Otherwise you'll have to manually use
3bcc57751283 Add 'muc_bookmark_autoupdate' (Hermitifier)
Mikael Berthe <mikael@lilotux.net>
parents: 1974
diff changeset
381 # command /room bookmark, or changes will not be permanent (for session only).
3bcc57751283 Add 'muc_bookmark_autoupdate' (Hermitifier)
Mikael Berthe <mikael@lilotux.net>
parents: 1974
diff changeset
382 # This setting will not add any bookmark, only update already existing ones.
3bcc57751283 Add 'muc_bookmark_autoupdate' (Hermitifier)
Mikael Berthe <mikael@lilotux.net>
parents: 1974
diff changeset
383 #set muc_bookmark_autoupdate = 0
837
7c74eef1d0e0 New option "muc_auto_whois"
Mikael Berthe <mikael@lilotux.net>
parents: 823
diff changeset
384
511
c7cdb9c6d7aa Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 500
diff changeset
385 # Status messages
1530
29c505d43b3e Use random resource suffix by default
Mikael Berthe <mikael@lilotux.net>
parents: 1526
diff changeset
386 # 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
387 #set message = Unique message status
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
388 #set message_avail = I'm available
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
389 #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
390 #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
391 #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
392 #set message_away = I'm away
522
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 517
diff changeset
393 #
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 517
diff changeset
394 # 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
395 # message will be restored when leaving auto-away status. If this message
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 517
diff changeset
396 # isn't defined, the status message will stay unchanged.
530
365e1ded7f1a Suggest "names" alias
Mikael Berthe <mikael@lilotux.net>
parents: 525
diff changeset
397 set message_autoaway = Auto-away (idle)
294
871e53769084 Allow one status message per Jabber status
Mikael Berthe <mikael@lilotux.net>
parents: 272
diff changeset
398
1386
8e763c2c331f Add option 'escdelay'
Mikael Berthe <mikael@lilotux.net>
parents: 1377
diff changeset
399 # Escape timeout delay (ESCDELAY)
8e763c2c331f Add option 'escdelay'
Mikael Berthe <mikael@lilotux.net>
parents: 1377
diff changeset
400 # The ESCDELAY variable specifies the time, in milliseconds, for which
8e763c2c331f Add option 'escdelay'
Mikael Berthe <mikael@lilotux.net>
parents: 1377
diff changeset
401 # the ncurses interface will await a character sequence.
8e763c2c331f Add option 'escdelay'
Mikael Berthe <mikael@lilotux.net>
parents: 1377
diff changeset
402 # The default is 1000 (1 second).
8e763c2c331f Add option 'escdelay'
Mikael Berthe <mikael@lilotux.net>
parents: 1377
diff changeset
403 # If you want mcabber to react faster after hitting Escape, you can lower
8e763c2c331f Add option 'escdelay'
Mikael Berthe <mikael@lilotux.net>
parents: 1377
diff changeset
404 # this value by setting the ESCDELAY environment variable or setting the
8e763c2c331f Add option 'escdelay'
Mikael Berthe <mikael@lilotux.net>
parents: 1377
diff changeset
405 # 'escdelay' option.
8e763c2c331f Add option 'escdelay'
Mikael Berthe <mikael@lilotux.net>
parents: 1377
diff changeset
406 set escdelay = 50
8e763c2c331f Add option 'escdelay'
Mikael Berthe <mikael@lilotux.net>
parents: 1377
diff changeset
407
511
c7cdb9c6d7aa Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 500
diff changeset
408 # Colors
267
8d3d5bd52da3 Improve color configuration
mikael@frmp8452
parents: 232
diff changeset
409 # Colors are: black, red, green, yellow, blue, magenta, cyan, white
739
0d5fb1d9077c Allow "bright" text colors
Mikael Berthe <mikael@lilotux.net>
parents: 736
diff changeset
410 # For text colors (i.e. not background and bg* colors) you can also use
0d5fb1d9077c Allow "bright" text colors
Mikael Berthe <mikael@lilotux.net>
parents: 736
diff changeset
411 # the "bright" prefix to get a bright/bold color. Example: brightblue
1417
783b47c9d963 Allow more than the 16 default colors (patch from mjs)
Mikael Berthe <mikael@lilotux.net>
parents: 1386
diff changeset
412 # You can use the "default" color, too (i.e. for transparent background).
783b47c9d963 Allow more than the 16 default colors (patch from mjs)
Mikael Berthe <mikael@lilotux.net>
parents: 1386
diff changeset
413 # If your terminal supports 256 colors, you can use the color number
783b47c9d963 Allow more than the 16 default colors (patch from mjs)
Mikael Berthe <mikael@lilotux.net>
parents: 1386
diff changeset
414 # directly (16-255).
712
e1639629c87b Rename color options
Mikael Berthe <mikael@lilotux.net>
parents: 702
diff changeset
415 #
1417
783b47c9d963 Allow more than the 16 default colors (patch from mjs)
Mikael Berthe <mikael@lilotux.net>
parents: 1386
diff changeset
416 # Have a look at the contrib/themes/ directory to see some sample
739
0d5fb1d9077c Allow "bright" text colors
Mikael Berthe <mikael@lilotux.net>
parents: 736
diff changeset
417 # color settings.
0d5fb1d9077c Allow "bright" text colors
Mikael Berthe <mikael@lilotux.net>
parents: 736
diff changeset
418 #
712
e1639629c87b Rename color options
Mikael Berthe <mikael@lilotux.net>
parents: 702
diff changeset
419 # background: background color of the chat window and the log window
e1639629c87b Rename color options
Mikael Berthe <mikael@lilotux.net>
parents: 702
diff changeset
420 # general: text color in the chat window and the log window
1268
dbc907b2d92f Add configurable colors for info and incoming messages (Michal 'vorner' Vaner)
Mikael Berthe <mikael@lilotux.net>
parents: 1267
diff changeset
421 # info: text color in the chat window for info messages
dbc907b2d92f Add configurable colors for info and incoming messages (Michal 'vorner' Vaner)
Mikael Berthe <mikael@lilotux.net>
parents: 1267
diff changeset
422 # msgin: text color in the chat window for incoming messages
785
7e0562e3bc83 Replace color_highlight with color_msgout
Mikael Berthe <mikael@lilotux.net>
parents: 766
diff changeset
423 # msgout: text color in the chat window for outgoing messages
1204
e802ec0c02d2 Basic support for nick highlighting in MUC rooms (the whole line is colored)
Mikael Berthe <mikael@lilotux.net>
parents: 1188
diff changeset
424 # msghl: text color in the chat window for highlighted messages (MUC)
712
e1639629c87b Rename color options
Mikael Berthe <mikael@lilotux.net>
parents: 702
diff changeset
425 # bgstatus: background color of the status lines
e1639629c87b Rename color options
Mikael Berthe <mikael@lilotux.net>
parents: 702
diff changeset
426 # status: text color of the status lines
2028
7b5bd6ad83b4 Add 'color_log' (text color in the log window)
Mikael Berthe <mikael@lilotux.net>
parents: 2013
diff changeset
427 # log: text color in the log window
712
e1639629c87b Rename color options
Mikael Berthe <mikael@lilotux.net>
parents: 702
diff changeset
428 # roster: text color of the roster (buddylist) normal items
e1639629c87b Rename color options
Mikael Berthe <mikael@lilotux.net>
parents: 702
diff changeset
429 # bgrostersel: background color of the selected roster item
e1639629c87b Rename color options
Mikael Berthe <mikael@lilotux.net>
parents: 702
diff changeset
430 # rostersel: text color of the selected roster item
723
23068490d063 Add text color when the selected buddy has an unread message
Mikael Berthe <mikael@lilotux.net>
parents: 719
diff changeset
431 # rosterselmsg:text color of the selected roster item, if there is a new msg
712
e1639629c87b Rename color options
Mikael Berthe <mikael@lilotux.net>
parents: 702
diff changeset
432 # rosternewmsg: text color of items with unread messages
2070
dd8ae0abfc68 mcabberrc: Add missing description for color_readmark
Mikael Berthe <mikael@lilotux.net>
parents: 2067
diff changeset
433 # readmark: text color of the "read mark" line in buffers
2090
16b04d64ec88 Add option to highlight timestamp added by server.
Hermitifier
parents: 2070
diff changeset
434 # timestamp: text color in the chat window for delayed timestamps
712
e1639629c87b Rename color options
Mikael Berthe <mikael@lilotux.net>
parents: 702
diff changeset
435 #
736
a8fa82e611c3 Change default background color in the sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 731
diff changeset
436 #set color_background = black
334
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
437 #set color_general = white
1281
b1be0c6862d4 Minor conffile changes
Mikael Berthe <mikael@lilotux.net>
parents: 1272
diff changeset
438 #set color_info = white
1268
dbc907b2d92f Add configurable colors for info and incoming messages (Michal 'vorner' Vaner)
Mikael Berthe <mikael@lilotux.net>
parents: 1267
diff changeset
439 #set color_msgin = white
785
7e0562e3bc83 Replace color_highlight with color_msgout
Mikael Berthe <mikael@lilotux.net>
parents: 766
diff changeset
440 #set color_msgout = cyan
1204
e802ec0c02d2 Basic support for nick highlighting in MUC rooms (the whole line is colored)
Mikael Berthe <mikael@lilotux.net>
parents: 1188
diff changeset
441 #set color_msghl = yellow
712
e1639629c87b Rename color options
Mikael Berthe <mikael@lilotux.net>
parents: 702
diff changeset
442 #set color_bgstatus = blue
e1639629c87b Rename color options
Mikael Berthe <mikael@lilotux.net>
parents: 702
diff changeset
443 #set color_status = white
2028
7b5bd6ad83b4 Add 'color_log' (text color in the log window)
Mikael Berthe <mikael@lilotux.net>
parents: 2013
diff changeset
444 #set color_log = white
712
e1639629c87b Rename color options
Mikael Berthe <mikael@lilotux.net>
parents: 702
diff changeset
445 #set color_roster = green
e1639629c87b Rename color options
Mikael Berthe <mikael@lilotux.net>
parents: 702
diff changeset
446 #set color_bgrostersel = cyan
e1639629c87b Rename color options
Mikael Berthe <mikael@lilotux.net>
parents: 702
diff changeset
447 #set color_rostersel = blue
723
23068490d063 Add text color when the selected buddy has an unread message
Mikael Berthe <mikael@lilotux.net>
parents: 719
diff changeset
448 #set color_rosterselmsg = red
712
e1639629c87b Rename color options
Mikael Berthe <mikael@lilotux.net>
parents: 702
diff changeset
449 #set color_rosternewmsg = red
1960
b596bcff758e Add 'color_readmark'
Mikael Berthe <mikael@lilotux.net>
parents: 1944
diff changeset
450 #set color_readmark = red
2090
16b04d64ec88 Add option to highlight timestamp added by server.
Hermitifier
parents: 2070
diff changeset
451 #set color_timestamp = brightblue
62
db2a1826bafa [/trunk] Changeset 77 by mikael
mikael
parents:
diff changeset
452
1605
79f3b780821a Update mcabberrc.example
Mikael Berthe <mikael@lilotux.net>
parents: 1598
diff changeset
453 # You can color roster items by their status and JID. For example, to have
1482
f16b280e70d4 Minor updates to the sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1472
diff changeset
454 # all roster items white, just all contacts from jabber.org that are away,
f16b280e70d4 Minor updates to the sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1472
diff changeset
455 # not available or do not disturb yellow, you do this:
1272
033576acac4c Add configurable roster colors (Michal 'vorner' Vaner)
Mikael Berthe <mikael@lilotux.net>
parents: 1269
diff changeset
456 #
033576acac4c Add configurable roster colors (Michal 'vorner' Vaner)
Mikael Berthe <mikael@lilotux.net>
parents: 1269
diff changeset
457 #color roster * * white
033576acac4c Add configurable roster colors (Michal 'vorner' Vaner)
Mikael Berthe <mikael@lilotux.net>
parents: 1269
diff changeset
458 #color roster adn *@jabber.org yellow
033576acac4c Add configurable roster colors (Michal 'vorner' Vaner)
Mikael Berthe <mikael@lilotux.net>
parents: 1269
diff changeset
459
1482
f16b280e70d4 Minor updates to the sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1472
diff changeset
460 # You can let mcabber color nicks in MUC.
f16b280e70d4 Minor updates to the sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1472
diff changeset
461 # These colors will by used automatically:
1293
359e1c53552a Coloring help
Michal 'vorner' Vaner <vorner@ucw.cz>
parents: 1286
diff changeset
462 #set nick_colors = red green blue
1482
f16b280e70d4 Minor updates to the sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1472
diff changeset
463 # This turns coloring of all mucs on:
1297
60663a1f9e8d Better help (unwrapped help file, comment in config)
Michal 'vorner' Vaner <vorner@ucw.cz>
parents: 1293
diff changeset
464 #color muc * on
1293
359e1c53552a Coloring help
Michal 'vorner' Vaner <vorner@ucw.cz>
parents: 1286
diff changeset
465 #
1482
f16b280e70d4 Minor updates to the sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1472
diff changeset
466 # If you want someone's nick to be the same all the time:
1293
359e1c53552a Coloring help
Michal 'vorner' Vaner <vorner@ucw.cz>
parents: 1286
diff changeset
467 #color mucnick my_friend yellow
359e1c53552a Coloring help
Michal 'vorner' Vaner <vorner@ucw.cz>
parents: 1286
diff changeset
468
511
c7cdb9c6d7aa Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 500
diff changeset
469 # Style
1530
29c505d43b3e Use random resource suffix by default
Mikael Berthe <mikael@lilotux.net>
parents: 1526
diff changeset
470 # Note: the 'log_win_height' and 'roster_width' values below can be set
702
3e34bd8e073d Update sample configuration file (roster_width option)
Mikael Berthe <mikael@lilotux.net>
parents: 676
diff changeset
471 # in real time when mcabber is running. Refresh the screen (Ctrl-l) to
3e34bd8e073d Update sample configuration file (roster_width option)
Mikael Berthe <mikael@lilotux.net>
parents: 676
diff changeset
472 # use the new values.
3e34bd8e073d Update sample configuration file (roster_width option)
Mikael Berthe <mikael@lilotux.net>
parents: 676
diff changeset
473 #
517
d8f4a0fc77d3 Update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
474 # Log window height (minimum 1, default 5)
d8f4a0fc77d3 Update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
475 #set log_win_height = 5
702
3e34bd8e073d Update sample configuration file (roster_width option)
Mikael Berthe <mikael@lilotux.net>
parents: 676
diff changeset
476 # Buddylist window width (minimum 2, default 24)
3e34bd8e073d Update sample configuration file (roster_width option)
Mikael Berthe <mikael@lilotux.net>
parents: 676
diff changeset
477 #set roster_width=24
517
d8f4a0fc77d3 Update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
478 #
1530
29c505d43b3e Use random resource suffix by default
Mikael Berthe <mikael@lilotux.net>
parents: 1526
diff changeset
479 # The options 'log_win_on_top' and 'roster_win_on_right' can change the
973
e693cbe33802 Add option 'roster_win_on_right'
Mikael Berthe <mikael@lilotux.net>
parents: 938
diff changeset
480 # position of the log window (top/bottom) and the position of the roster
e693cbe33802 Add option 'roster_win_on_right'
Mikael Berthe <mikael@lilotux.net>
parents: 938
diff changeset
481 # (left/right).
e693cbe33802 Add option 'roster_win_on_right'
Mikael Berthe <mikael@lilotux.net>
parents: 938
diff changeset
482 #set log_win_on_top = 0
e693cbe33802 Add option 'roster_win_on_right'
Mikael Berthe <mikael@lilotux.net>
parents: 938
diff changeset
483 #set roster_win_on_right = 0
e693cbe33802 Add option 'roster_win_on_right'
Mikael Berthe <mikael@lilotux.net>
parents: 938
diff changeset
484 #
2100
113d3b96ae3e Add option 'attention_char'
Mikael Berthe <mikael@lilotux.net>
parents: 2098
diff changeset
485 # The attention sign (default: '!') used when a private message is received
113d3b96ae3e Add option 'attention_char'
Mikael Berthe <mikael@lilotux.net>
parents: 2098
diff changeset
486 # can be changed with the 'attention_char' option.
113d3b96ae3e Add option 'attention_char'
Mikael Berthe <mikael@lilotux.net>
parents: 2098
diff changeset
487 #set attention_char = !
113d3b96ae3e Add option 'attention_char'
Mikael Berthe <mikael@lilotux.net>
parents: 2098
diff changeset
488 #
1348
26d1dd2c948f Add option 'roster_hide_domain'
Mikael Berthe <mikael@lilotux.net>
parents: 1347
diff changeset
489 # By default, the displayed name of a contact in the roster window will
1610
6db9f403f707 Replace 'username' with 'jid' in the configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1605
diff changeset
490 # be the JID if no name has been specified. You can use the following
1348
26d1dd2c948f Add option 'roster_hide_domain'
Mikael Berthe <mikael@lilotux.net>
parents: 1347
diff changeset
491 # option if you only want to see the username part.
26d1dd2c948f Add option 'roster_hide_domain'
Mikael Berthe <mikael@lilotux.net>
parents: 1347
diff changeset
492 #set roster_hide_domain = 0
26d1dd2c948f Add option 'roster_hide_domain'
Mikael Berthe <mikael@lilotux.net>
parents: 1347
diff changeset
493 #
511
c7cdb9c6d7aa Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 500
diff changeset
494 # Buddy name format (in status window):
c7cdb9c6d7aa Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 500
diff changeset
495 # - 0: (default) "<jid/resource>"
1610
6db9f403f707 Replace 'username' with 'jid' in the configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1605
diff changeset
496 # - 1: "name <jid/resource>" (name is omitted if same as the JID)
6db9f403f707 Replace 'username' with 'jid' in the configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1605
diff changeset
497 # - 2: "name/resource" (if the name is the same as the JID, use <jid/res>)
6db9f403f707 Replace 'username' with 'jid' in the configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1605
diff changeset
498 # - 3: "name" (if the name is the same as the JID, use <jid/res>)
511
c7cdb9c6d7aa Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 500
diff changeset
499 #set buddy_format = 2
517
d8f4a0fc77d3 Update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
500 #
1286
02ad6200df26 Add selectable time prefixes (vorner)
Mikael Berthe <mikael@lilotux.net>
parents: 1281
diff changeset
501 # Time format:
02ad6200df26 Add selectable time prefixes (vorner)
Mikael Berthe <mikael@lilotux.net>
parents: 1281
diff changeset
502 # - 0: (default) Date and time
02ad6200df26 Add selectable time prefixes (vorner)
Mikael Berthe <mikael@lilotux.net>
parents: 1281
diff changeset
503 # - 1: Time only
02ad6200df26 Add selectable time prefixes (vorner)
Mikael Berthe <mikael@lilotux.net>
parents: 1281
diff changeset
504 # - 2: None
02ad6200df26 Add selectable time prefixes (vorner)
Mikael Berthe <mikael@lilotux.net>
parents: 1281
diff changeset
505 #set time_prefix = 0
02ad6200df26 Add selectable time prefixes (vorner)
Mikael Berthe <mikael@lilotux.net>
parents: 1281
diff changeset
506 #
1482
f16b280e70d4 Minor updates to the sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1472
diff changeset
507 # When a contact sends "/me ", mcabber displays "*user ", where user
1610
6db9f403f707 Replace 'username' with 'jid' in the configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1605
diff changeset
508 # is the local part of the contact's JID.
6db9f403f707 Replace 'username' with 'jid' in the configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1605
diff changeset
509 # If you want mcabber to display the complete bare JID (user@server.com),
1530
29c505d43b3e Use random resource suffix by default
Mikael Berthe <mikael@lilotux.net>
parents: 1526
diff changeset
510 # set 'buddy_me_fulljid' to 1 (default: 0)
1188
ef40688d87bd Add option 'buddy_me_fulljid'
Mikael Berthe <mikael@lilotux.net>
parents: 1167
diff changeset
511 #set buddy_me_fulljid = 1
ef40688d87bd Add option 'buddy_me_fulljid'
Mikael Berthe <mikael@lilotux.net>
parents: 1167
diff changeset
512 #
1450
c6ebf66a4f80 Add option 'log_display_presence'
Mikael Berthe <mikael@lilotux.net>
parents: 1447
diff changeset
513 # Display the status changes in the log window (default: 0, never)
c6ebf66a4f80 Add option 'log_display_presence'
Mikael Berthe <mikael@lilotux.net>
parents: 1447
diff changeset
514 # Set 'log_display_presence' to 1 to enable.
c6ebf66a4f80 Add option 'log_display_presence'
Mikael Berthe <mikael@lilotux.net>
parents: 1447
diff changeset
515 #set log_display_presence = 0
c6ebf66a4f80 Add option 'log_display_presence'
Mikael Berthe <mikael@lilotux.net>
parents: 1447
diff changeset
516 #
517
d8f4a0fc77d3 Update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
517 # 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
518 # Values: 0: never 1: only connect/disconnect 2: all
d8f4a0fc77d3 Update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
519 #set show_status_in_buffer = 1
808
4a6ce276ffca New option "log_display_sender"
Mikael Berthe <mikael@lilotux.net>
parents: 785
diff changeset
520 #
1610
6db9f403f707 Replace 'username' with 'jid' in the configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1605
diff changeset
521 # Set 'log_display_sender' to 1 to display the message sender's JID in the
808
4a6ce276ffca New option "log_display_sender"
Mikael Berthe <mikael@lilotux.net>
parents: 785
diff changeset
522 # log window (default: 0, no)
4a6ce276ffca New option "log_display_sender"
Mikael Berthe <mikael@lilotux.net>
parents: 785
diff changeset
523 #set log_display_sender = 0
1514
939e2957f8a8 Add option "info" (suggested by lego)
franky@diable
parents: 1498
diff changeset
524 #
1530
29c505d43b3e Use random resource suffix by default
Mikael Berthe <mikael@lilotux.net>
parents: 1526
diff changeset
525 # Set 'info' to anything you'd like to see in your lower status line.
1514
939e2957f8a8 Add option "info" (suggested by lego)
franky@diable
parents: 1498
diff changeset
526 #set info = woot
2013
8dc418af3e72 Allow to select to which buddy resource messages go. Closes issue #55
Hermitifier
parents: 2009
diff changeset
527 #
8dc418af3e72 Allow to select to which buddy resource messages go. Closes issue #55
Hermitifier
parents: 2009
diff changeset
528 # Automatic locking on buddy resource that messages are coming from.
8dc418af3e72 Allow to select to which buddy resource messages go. Closes issue #55
Hermitifier
parents: 2009
diff changeset
529 # Useful when your buddies are chatting from their non-highest priority
8dc418af3e72 Allow to select to which buddy resource messages go. Closes issue #55
Hermitifier
parents: 2009
diff changeset
530 # resources, forcing you to use /say_to command.
8dc418af3e72 Allow to select to which buddy resource messages go. Closes issue #55
Hermitifier
parents: 2009
diff changeset
531 #set roster_autolock_resource = 1
2098
c4a68361883f Lock buffer automatically when scrolled up, unlock when at bottom ("buffer_smart_scrolling" setting)
Hermitifier
parents: 2090
diff changeset
532 #
c4a68361883f Lock buffer automatically when scrolled up, unlock when at bottom ("buffer_smart_scrolling" setting)
Hermitifier
parents: 2090
diff changeset
533 # Automatic locking of buffer when scrolled up, and unlocking when scrolled
c4a68361883f Lock buffer automatically when scrolled up, unlock when at bottom ("buffer_smart_scrolling" setting)
Hermitifier
parents: 2090
diff changeset
534 # to bottom.
c4a68361883f Lock buffer automatically when scrolled up, unlock when at bottom ("buffer_smart_scrolling" setting)
Hermitifier
parents: 2090
diff changeset
535 # Set 'buffer_smart_scrolling' to 1 to enable.
c4a68361883f Lock buffer automatically when scrolled up, unlock when at bottom ("buffer_smart_scrolling" setting)
Hermitifier
parents: 2090
diff changeset
536 # Note: manual command "/buffer scroll_lock" will not work when smart scrolling
c4a68361883f Lock buffer automatically when scrolled up, unlock when at bottom ("buffer_smart_scrolling" setting)
Hermitifier
parents: 2090
diff changeset
537 # is enabled. Command "/buffer scroll_unlock" will only work if there is a new
c4a68361883f Lock buffer automatically when scrolled up, unlock when at bottom ("buffer_smart_scrolling" setting)
Hermitifier
parents: 2090
diff changeset
538 # message received.
c4a68361883f Lock buffer automatically when scrolled up, unlock when at bottom ("buffer_smart_scrolling" setting)
Hermitifier
parents: 2090
diff changeset
539 #set buffer_smart_scrolling = 0
511
c7cdb9c6d7aa Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 500
diff changeset
540
1068
6646d2ed7f74 Allow pgp commands in config file, update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1042
diff changeset
541 # Contacts PGP information
6646d2ed7f74 Allow pgp commands in config file, update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1042
diff changeset
542 # You can provide a PGP key to be used for a given Jabber user, or
1110
6db427a14ee8 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1101
diff changeset
543 # disable PGP on a per-account basis.
1068
6646d2ed7f74 Allow pgp commands in config file, update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1042
diff changeset
544 # If you provide a KeyId for a contact, it will be compared to the key the
6646d2ed7f74 Allow pgp commands in config file, update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1042
diff changeset
545 # contact uses to sign their presence/messages and it will be used for
6646d2ed7f74 Allow pgp commands in config file, update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1042
diff changeset
546 # all outgoing encrypted messages (that is, the contact signature key will
6646d2ed7f74 Allow pgp commands in config file, update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1042
diff changeset
547 # be ignored).
6646d2ed7f74 Allow pgp commands in config file, update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1042
diff changeset
548 # Please note that the key must match exactly the id seen with /info.
6646d2ed7f74 Allow pgp commands in config file, update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1042
diff changeset
549 #pgp disable foo@bar.org
6646d2ed7f74 Allow pgp commands in config file, update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1042
diff changeset
550 #pgp setkey bar@foo.net C9940A9BB0B92210
6646d2ed7f74 Allow pgp commands in config file, update sample configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1042
diff changeset
551
1347
07816313073b Add an option 'otr' to enable OTR support in the configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1320
diff changeset
552 # OTR (Off-The-Record messaging) support
07816313073b Add an option 'otr' to enable OTR support in the configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1320
diff changeset
553 # (Only available if mcabber is built with OTR support)
07816313073b Add an option 'otr' to enable OTR support in the configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1320
diff changeset
554 # Set otr to 1 to enable OTR support.
07816313073b Add an option 'otr' to enable OTR support in the configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1320
diff changeset
555 # You cannot change this option once mcabber is running.
07816313073b Add an option 'otr' to enable OTR support in the configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1320
diff changeset
556 #set otr = 0
07816313073b Add an option 'otr' to enable OTR support in the configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1320
diff changeset
557 #
1320
cb400799db8f Configurable OTR directory
franky@veqlargh.fs
parents: 1318
diff changeset
558 # OTR directory
1347
07816313073b Add an option 'otr' to enable OTR support in the configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1320
diff changeset
559 # You can specify the OTR directory with the otr_dir option
07816313073b Add an option 'otr' to enable OTR support in the configuration file
Mikael Berthe <mikael@lilotux.net>
parents: 1320
diff changeset
560 # (default = ~/.mcabber/otr/).
1320
cb400799db8f Configurable OTR directory
franky@veqlargh.fs
parents: 1318
diff changeset
561 #set otr_dir = "~/.mcabber/otr/"
1557
31422cb73356 Mention otrpolicy in the sample configuration file (suggested by T. Glaser)
Mikael Berthe <mikael@lilotux.net>
parents: 1549
diff changeset
562 #
31422cb73356 Mention otrpolicy in the sample configuration file (suggested by T. Glaser)
Mikael Berthe <mikael@lilotux.net>
parents: 1549
diff changeset
563 # You can set OTR policies from the configuration file (use /help otrpolicy
31422cb73356 Mention otrpolicy in the sample configuration file (suggested by T. Glaser)
Mikael Berthe <mikael@lilotux.net>
parents: 1549
diff changeset
564 # for the details).
31422cb73356 Mention otrpolicy in the sample configuration file (suggested by T. Glaser)
Mikael Berthe <mikael@lilotux.net>
parents: 1549
diff changeset
565 #otrpolicy default manual
1320
cb400799db8f Configurable OTR directory
franky@veqlargh.fs
parents: 1318
diff changeset
566
2000
1fe1e8d1d1ea Document previous changeset
Hermitifier
parents: 1980
diff changeset
567 # Entity Caps cache
1fe1e8d1d1ea Document previous changeset
Hermitifier
parents: 1980
diff changeset
568 # You can provide a directory where mcabber will store an offline cache
1fe1e8d1d1ea Document previous changeset
Hermitifier
parents: 1980
diff changeset
569 # of other clients' capabilities. This will likely reduce network overhead
1fe1e8d1d1ea Document previous changeset
Hermitifier
parents: 1980
diff changeset
570 # on start of new session.
1fe1e8d1d1ea Document previous changeset
Hermitifier
parents: 1980
diff changeset
571 #set caps_directory = "~/.mcabber/caps"
1fe1e8d1d1ea Document previous changeset
Hermitifier
parents: 1980
diff changeset
572
511
c7cdb9c6d7aa Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 500
diff changeset
573 # Aliases
550
89cc86940f09 Add an alias for "/me"
Mikael Berthe <mikael@lilotux.net>
parents: 530
diff changeset
574 alias me = say /me
334
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
575 alias online = status online
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
576 alias away = status away
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
577 alias dnd = status dnd
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
578 alias notavail = status notavail
530
365e1ded7f1a Suggest "names" alias
Mikael Berthe <mikael@lilotux.net>
parents: 525
diff changeset
579 #alias names = room names
1269
6495aa83d059 Small changes to the sample config file (suggested by bb)
Mikael Berthe <mikael@lilotux.net>
parents: 1268
diff changeset
580 #alias topic = room topic
334
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
581
1563
c1d0f906d379 Add option "use_mouse"
franky
parents: 1557
diff changeset
582 # Set use_mouse to 1 to map mouse buttons like keycodes.
c1d0f906d379 Add option "use_mouse"
franky
parents: 1557
diff changeset
583 #set use_mouse = 1
c1d0f906d379 Add option "use_mouse"
franky
parents: 1557
diff changeset
584
511
c7cdb9c6d7aa Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 500
diff changeset
585 # Key bindings
1585
da6a359c8a03 Fix typo reported in issue #34
Mikael Berthe <mikael@lilotux.net>
parents: 1563
diff changeset
586 # Ctrl-q (17) bound to /roster unread_next
1131
73e6ca0a03a9 Un-hardcode Ctrl-q binding, it can be done in the config. file
Mikael Berthe <mikael@lilotux.net>
parents: 1129
diff changeset
587 bind 17 = roster unread_next
1585
da6a359c8a03 Fix typo reported in issue #34
Mikael Berthe <mikael@lilotux.net>
parents: 1563
diff changeset
588 # Ctrl-x (24) bound to /roster alternate
334
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
589 bind 24 = roster alternate
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
590 # 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
591 bind 269 = roster toggle_offline
719
241c9128766a Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 712
diff changeset
592 # F12 (276) bound to /roster toggle
241c9128766a Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 712
diff changeset
593 bind 276 = roster toggle
766
c71ff9ade18c Move Ctrl-Up/Down bindings to the config. file
Mikael Berthe <mikael@lilotux.net>
parents: 739
diff changeset
594 # Ctrl-Up/Ctrl-Down bound to /buffer up/down (like Ctrl-p/Ctrl-n)
c71ff9ade18c Move Ctrl-Up/Down bindings to the config. file
Mikael Berthe <mikael@lilotux.net>
parents: 739
diff changeset
595 bind 521 = buffer up
c71ff9ade18c Move Ctrl-Up/Down bindings to the config. file
Mikael Berthe <mikael@lilotux.net>
parents: 739
diff changeset
596 bind 514 = buffer down
334
475dccabe6f3 New config. file parsing -- update sample config. file
Mikael Berthe <mikael@lilotux.net>
parents: 322
diff changeset
597
719
241c9128766a Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 712
diff changeset
598 # Sample alias to join mcabber channel with "/jmc"
241c9128766a Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 712
diff changeset
599 #alias jmc = room join mcabber@conf.lilotux.net