0
|
1 .\" |
|
2 .\" Copyright (c) 2013-2016 David Demelier <markand@malikania.fr> |
|
3 .\" |
|
4 .\" Permission to use, copy, modify, and/or distribute this software for any |
|
5 .\" purpose with or without fee is hereby granted, provided that the above |
|
6 .\" copyright notice and this permission notice appear in all copies. |
|
7 .\" |
|
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
|
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
|
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
|
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
|
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
|
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
|
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
|
15 .\" |
|
16 .Dd @MONTH@ @DAY@, @YEAR@ |
|
17 .Dt IRCCDCTL.CONF 5 |
|
18 .Os |
|
19 .Sh NAME |
|
20 .Nm irccdctl.conf |
|
21 .Nd irccdctl configuration file |
|
22 .Sh DESCRIPTION |
|
23 The file |
|
24 .Nm irccdctl.conf |
|
25 contains all parameters for the application |
|
26 .Nm irccdctl . |
|
27 .Pp |
|
28 The irccdctl.conf file is .ini based syntax, it supports sections enclosed |
|
29 between brackets where one or more options lives. |
|
30 .\" SYNTAX |
|
31 .Sh SYNTAX |
|
32 The usual syntax is: |
|
33 .Bd -literal -offset indent |
|
34 [foo] |
|
35 option = value |
|
36 |
|
37 [bar] |
|
38 name = "long string enclosed between quotes" |
|
39 .Pp |
|
40 .Ed |
|
41 Comments starts by # or can be written at an end of a line. |
|
42 .Pp |
|
43 Note that quotes are needed if the value has more that one word, if not the |
|
44 value will be truncated at the first space found. |
|
45 .Pp |
|
46 Multiple options on the same line are |
|
47 .Em not |
|
48 supported. |
|
49 .\" CONFIGURATION |
|
50 .Sh CONFIGURATION |
|
51 This section shows all available sections with the options allowed for them. |
|
52 .\" GENERAL |
|
53 .Ss general |
|
54 This section covers general options. |
|
55 .Pp |
|
56 .Bl -tag -width PARAMETERXXX -compact |
|
57 .It verbose |
|
58 (bool) enable verbose message (Optional, default: false) |
|
59 .El |
|
60 .Pp |
|
61 .\" CONNECT |
|
62 .Ss connect |
|
63 This section covers the sockets to connect to an irccd(1) instance. You must |
|
64 set this only once. |
|
65 .Pp |
|
66 .Bl -tag -width PARAMETERXXX -compact |
|
67 .It type |
|
68 (string) type of listener "ip" or "unix" |
|
69 .El |
|
70 .Pp |
|
71 The following parameters are available for type "ip": |
|
72 .Pp |
|
73 .Bl -tag -width PARAMETERXXX -compact -offset indent |
|
74 .It host |
|
75 (string) host to connect, |
|
76 .It port |
|
77 (int) port number, |
|
78 .It family |
|
79 (string) internet family: ipv6 or ipv4 (Optional, default: ipv4). |
|
80 .El |
|
81 .Pp |
|
82 The following parameters are available for type "unix": |
|
83 .Pp |
|
84 .Bl -tag -width PARAMETERXXX -compact -offset indent |
|
85 .It path |
|
86 (string) the file path to the socket. |
|
87 .El |
|
88 .\" FILES |
|
89 .Sh FILES |
|
90 The default config file is located at |
|
91 .Em @CMAKE_INSTALL_PREFIX@/@WITH_ETCDIR@/irccdctl.conf |
|
92 .Pp |
|
93 The user defined file follow the XDG standard and is usually |
|
94 .Em $HOME/.config/irccd/irccdctl.conf . |
|
95 If the XDG variable is not set, we use that path. |
|
96 .\" SEE ALSO |
|
97 .Sh SEE ALSO |
|
98 .Xr irccdctl 1 |
|
99 .\" AUTHORS |
|
100 .Sh AUTHORS |
|
101 irccd was written by David Demelier <markand@malikania.fr> |