Mercurial > irccd
annotate doc/man/irccdctl.conf.5.in @ 405:31837008f7e2
Docs: document the authentication support (man, html)
author | David Demelier <markand@malikania.fr> |
---|---|
date | Mon, 16 Jan 2017 10:36:49 +0100 |
parents | c6fbb6e0e06d |
children | a8da63738428 |
rev | line source |
---|---|
0 | 1 .\" |
394 | 2 .\" Copyright (c) 2013-2017 David Demelier <markand@malikania.fr> |
0 | 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 | |
405
31837008f7e2
Docs: document the authentication support (man, html)
David Demelier <markand@malikania.fr>
parents:
394
diff
changeset
|
68 (string) type of listener "ip" or "unix". |
31837008f7e2
Docs: document the authentication support (man, html)
David Demelier <markand@malikania.fr>
parents:
394
diff
changeset
|
69 .It password |
31837008f7e2
Docs: document the authentication support (man, html)
David Demelier <markand@malikania.fr>
parents:
394
diff
changeset
|
70 (string) an authentication password (Optional, default: none). |
0 | 71 .El |
72 .Pp | |
73 The following parameters are available for type "ip": | |
74 .Pp | |
75 .Bl -tag -width PARAMETERXXX -compact -offset indent | |
76 .It host | |
77 (string) host to connect, | |
78 .It port | |
79 (int) port number, | |
80 .It family | |
81 (string) internet family: ipv6 or ipv4 (Optional, default: ipv4). | |
82 .El | |
83 .Pp | |
84 The following parameters are available for type "unix": | |
85 .Pp | |
86 .Bl -tag -width PARAMETERXXX -compact -offset indent | |
87 .It path | |
88 (string) the file path to the socket. | |
89 .El | |
372
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
90 .\" ALIAS |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
91 .Ss alias |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
92 The alias section can be used to define custom user commands. |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
93 .Pp |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
94 To define an alias, just add a new section named |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
95 .Nm alias.name |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
96 where name is your desired alias name. |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
97 .Pp |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
98 Then, add any option you like to execute commands you want. The option name is |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
99 ignored and serves as auto-documentation only. |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
100 .Pp |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
101 Example: |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
102 .Bd -literal |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
103 [alias.present] |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
104 say-hello = ( "server-message", "localhost", "#staff", "hello world!" ) |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
105 warning = ( "server-me", "localhost", "#staff", "is a bot") |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
106 .Ed |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
107 .Pp |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
108 .Nm Placeholders |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
109 .Pp |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
110 Sometimes, you want to pass parameters to your alias. The placeholder syntax |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
111 allows you to define where your command line arguments will be replaced before |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
112 being sent to irccd. |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
113 .Pp |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
114 The syntax uses `%n` where **n** is an integer starting from 0. |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
115 .Pp |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
116 Example: |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
117 .Bd -literal |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
118 [alias.present] |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
119 say-hello = ( "server-message", "%0", "%1", "hello world!" ) |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
120 warning = ( "server-me", "%0", "%1", "is a bot") |
6a7850696b86
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
121 .Ed |
0 | 122 .\" FILES |
123 .Sh FILES | |
124 The default config file is located at | |
51
2a6ac6daceee
Docs: fix various typos in manuals
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
125 .Em @CMAKE_INSTALL_PREFIX@/@WITH_CONFDIR@/irccdctl.conf |
0 | 126 .Pp |
127 The user defined file follow the XDG standard and is usually | |
128 .Em $HOME/.config/irccd/irccdctl.conf . | |
129 If the XDG variable is not set, we use that path. | |
130 .\" SEE ALSO | |
131 .Sh SEE ALSO | |
132 .Xr irccdctl 1 | |
133 .\" AUTHORS | |
134 .Sh AUTHORS | |
135 irccd was written by David Demelier <markand@malikania.fr> |