Mercurial > irccd

annotate examples/irccd.conf.sample @ 1189:b98294e7cadc release-4.0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
tests: improve on slow machines
author David Demelier <markand@malikania.fr>
date Thu, 09 Mar 2023 12:40:47 +0100
parents be767bfa5c2e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1113
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 # This is an example of irccd.conf file.
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 # Comments start with a '#' like this header and until ends at the end of line.
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 # See the irccd.conf(5) manual page for details of the file syntax and
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 # available options.
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
9
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 # logs
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 # ----------------------------------------------------------------------
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 # You can configure verbosity and adapter which can be console to log to
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 # stdout/stderr, syslog for system logging or a unique file.
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 # Default is non-verbose on console
1138
be767bfa5c2e examples: update C plugin
David Demelier <markand@malikania.fr>
parents: 1113
diff changeset
18 #
1113
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
19
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 logs to console
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 # Verbose on syslog:
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 # logs verbose to syslog
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 # Explicitly quiet to a file:
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 # logs quiet to file "/var/log/irccd/messages"
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
29
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 # transport
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 # ----------------------------------------------------------------------
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 # Enable irccd control through a UNIX domain socket via TCP. This is required
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 # for the irccdctl utility.
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 # You must use a quoted string because the parser does not understand a string
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 # starting with a '/' yet.
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
40
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 transport to "/tmp/irccd.sock"
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
42
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 # You can use user/group with both names instead of numeric literals.
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 # transport to "/tmp/irccd.sock" with uid "www" gid "www"
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 # transport to "/tmp/irccd.sock" with uid 1000 gid "users"
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
48
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 # server
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 # ----------------------------------------------------------------------
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 # Connect to an IRC server. Create a block for every server you want irccd to
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 # connect to.
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 # The options `hostname', `port' and `ident' are required.
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 # It is recommended to put quotes around the server identifiers to avoid
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 # colliding with syntax keywords.
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 # server "example" {
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 # hostname "example.org"; # Quotes are preferred.
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 # port 6667; # Don't use quotes, it's a number.
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 # ident "frc" "frc" "frc"; # Nickname, Username and Real name. There are no
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 # # comma because it's not a list.
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
66 # ssl; # Set to enable SSL.
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 # channels "#test", "#staff"; # List of channels to join.
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
68 # options AUTO-REJOIN; # Enable auto-rejoin after a kick.
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 # prefix "!"; # Prefix for invoking plugins.
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 # ctcp {
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
71 # version "my version"; # Custom CTCP VERSION reply.
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 # source "my SCM location"; # Custom CTCP SOURCE reply.
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 # }
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
74 # }
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
75 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
76
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
77 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
78 # rule
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
79 # ----------------------------------------------------------------------
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
80 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
81 # Create rules to filter plugins and their usage depending on criteria. They are
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
82 # evaluated in order they are defined. An empty block match every event.
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
83 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
84 # This rule drop *everything*.
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
85 # rule drop
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
86 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
87 # This rule `reallows' plugins hangman on channel #games and #test from the
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
88 # server example.
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
89 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
90 # rule accept {
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
91 # servers "example";
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
92 # plugins "hangman";
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
93 # channels "#test", "#games";
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
94 # }
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
95 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
96
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
97 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
98 # hooks
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
99 # ----------------------------------------------------------------------
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
100 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
101 # Hooks are independant approach to capturing events. They are invoked as-is
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
102 # from irccd upon a new event. They can be written in any language as long as
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
103 # they are executable. They can't be filtered through rules.
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
104 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
105 # hook "notify" to "/usr/local/bin/myscript.sh"
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
106 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
107
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
108 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
109 # plugins
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
110 # ----------------------------------------------------------------------
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
111 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
112 # Load Javascript and native C plugins. The block options is optional, if not
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
113 # present the plugin is searched through a standard set of directories.
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
114 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
115 # It is recommended to put quotes around the plugin identifiers to avoid
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
116 # colliding with syntax keywords.
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
117 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
118 # This will load the plugin `ask' from default path and default options.
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
119 # plugin "ask"
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
120 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
121 # This will load the plugin `hangman' and set custom configuration options and
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
122 # templates.
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
123 # plugin "hangman" {
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
124 # config {
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
125 # "collaborative" "false";
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
126 # }
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
127 # templates {
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
128 # "win" "Congrats #{nickname}, you found #{word}";
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
129 # }
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
130 # }
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
131 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
132 # This will load a plugin `custom' with a custom location and override its
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
133 # paths.
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
134 # plugin "custom" {
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
135 # location "/opt/custom.js";
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
136 #
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
137 # paths {
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
138 # "data" "/opt/custom/data";
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
139 # "cache" "/opt/custom/cache";
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
140 # "config" "/opt/custom";
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
141 # }
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
142 # }
c7c3bc804223 examples: install irccd.conf.sample
David Demelier <markand@malikania.fr>
parents:
diff changeset
143 #