annotate doc/examples/irccdctl.conf.sample @ 779:317c66a131be

Irccd: merge [identity] with [server], closes #905 @2h While here, also add some tests for server_util, #779
author David Demelier <markand@malikania.fr>
date Thu, 01 Nov 2018 10:34:21 +0100
parents 365bc7a3c4a3
children 54496ac51649
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 #
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 # irccdctl.conf -- config file for irccdctl
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 #
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 # Section general:
207
6635b9187d71 Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
6 # This section describe global options used by irccd.
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 #
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 # [general]
207
6635b9187d71 Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
9 # verbose = false # (bool) enable verbose message (Optional, default: false).
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 [general]
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 # Section connect:
207
6635b9187d71 Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
15 # This section is used to connect to a irccd transport.
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 #
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 # For internet sockets:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 #
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 # [connect]
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 # type = "ip"
207
6635b9187d71 Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
21 # host = "localhost" # (string) host to connect,
6635b9187d71 Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
22 # port = "1234" # (int) port number,
469
365bc7a3c4a3 Docs: remove ambiguous default value in irccdctl.conf
David Demelier <markand@malikania.fr>
parents: 269
diff changeset
23 # family = "ipv4" or "ipv6" # (string) internet family: ipv6 or ipv4 (Optional, default: ipv4).
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 #
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 # For unix sockets:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 #
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 # [connect]
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 # type = "unix"
207
6635b9187d71 Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
29 # path = "/tmp/irccd.sock" # (string) the file path to the socket.
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
30
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 [connect]
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 type = "ip"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 host = "localhost"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 port = "5980"