0
|
1 # Irccdctl |
|
2 |
|
3 The `irccdctl` utility let you controlling a running `irccd` instance. It uses sockets to perform any operation. |
|
4 |
|
5 You need to define at least one transport before using `irccdctl`. |
|
6 |
|
7 ## Configuration |
|
8 |
|
9 Configuration of irccdctl is done in the same rules than `irccd`. |
|
10 |
|
11 ### The general section |
|
12 |
|
13 This section defines the global irccdctl parameters. |
|
14 |
|
15 The available options: |
|
16 |
|
17 - **verbose**: (bool) enable verbose message (Optional, default: false). |
|
18 |
|
19 **Example** |
|
20 |
|
21 ````ini |
|
22 [general] |
|
23 verbose = true |
|
24 ```` |
|
25 |
|
26 ## The connect section |
|
27 |
|
28 The section socket permit irccdctl to connect to a specific irccd listener, only one may be defined. Just like |
|
29 transports you can connect to Unix or internet sockets. |
|
30 |
|
31 The available options: |
|
32 |
|
33 - **type**: (string) type of listener "ip" or "unix" |
|
34 |
|
35 The options for **internet** type: |
|
36 |
|
37 - **host**: (string) host to connect, |
|
38 - **port**: (int) port number, |
|
39 - **family**: (string) internet family: ipv6 or ipv4 (Optional, default: ipv4). |
|
40 |
|
41 The options for **unix** type: |
|
42 |
|
43 - **path**: (string) Required. The file path to the socket. |
|
44 |
|
45 **Example for internet transports** |
|
46 |
|
47 ````ini |
|
48 [connect] |
|
49 type = "internet" |
|
50 host = "localhost" |
|
51 port = "9999" |
|
52 family = "ipv6" |
|
53 ```` |
|
54 |
|
55 **Example for unix transports** |
|
56 |
|
57 ````ini |
|
58 [connect] |
|
59 type = "unix" |
|
60 path = "/tmp/irccd.sock" |
|
61 ```` |