Mercurial > irccd

annotate doc/html/guide/05-irccdctl/01-config.md @ 203:c26754e419c4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Irccd: rename RemoteCommand to Command
author David Demelier <markand@malikania.fr>
date Thu, 09 Jun 2016 13:50:55 +0200
parents 1158cffe5a5e
children
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 # Irccdctl
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 The `irccdctl` utility let you controlling a running `irccd` instance. It uses sockets to perform any operation.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 You need to define at least one transport before using `irccdctl`.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 ## Configuration
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 Configuration of irccdctl is done in the same rules than `irccd`.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 ### The general section
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 This section defines the global irccdctl parameters.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 The available options:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 - **verbose**: (bool) enable verbose message (Optional, default: false).
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 **Example**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 ````ini
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 [general]
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 verbose = true
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
25
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 ## The connect section
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
27
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 The section socket permit irccdctl to connect to a specific irccd listener, only one may be defined. Just like
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 transports you can connect to Unix or internet sockets.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
30
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 The available options:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
32
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 - **type**: (string) type of listener "ip" or "unix"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
34
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 The options for **internet** type:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
36
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 - **host**: (string) host to connect,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 - **port**: (int) port number,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 - **family**: (string) internet family: ipv6 or ipv4 (Optional, default: ipv4).
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
40
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 The options for **unix** type:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
42
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 - **path**: (string) Required. The file path to the socket.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
44
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 **Example for internet transports**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
46
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 ````ini
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 [connect]
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 type = "internet"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 host = "localhost"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 port = "9999"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 family = "ipv6"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
54
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 **Example for unix transports**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
56
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 ````ini
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 [connect]
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 type = "unix"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 path = "/tmp/irccd.sock"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 ````