Mercurial > irccd

annotate man/irccd.conf.5 @ 925:d585adeee610

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
irccd: enable auto-reconnect by default as specified in manual page
author David Demelier <markand@malikania.fr>
date Mon, 04 Jan 2021 10:27:54 +0100
parents ffffe5956a2e
children 2a6d753f79f6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 .\"
913
5e25439fe98d misc: update years
David Demelier <markand@malikania.fr>
parents: 911
diff changeset
2 .\" Copyright (c) 2013-2020 David Demelier <markand@malikania.fr>
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 .\"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 .\" Permission to use, copy, modify, and/or distribute this software for any
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 .\" purpose with or without fee is hereby granted, provided that the above
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 .\" copyright notice and this permission notice appear in all copies.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 .\"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 .\"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 .Dd @IRCCD_MAN_DATE@
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 .Dt IRCCD.CONF 5
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 .Os
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 .\" NAME
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 .Sh NAME
906
b831d9f48b0e doc: fix various errors
David Demelier <markand@malikania.fr>
parents: 884
diff changeset
21 .Nm irccd.conf
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 .Nd irccd configuration file
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 .\" DESCRIPTION
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 .Sh DESCRIPTION
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 Both
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 .Nm irccd
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 and
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 .Nm irccdctl
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 use configuration file in a extended INI format. This section will briefly
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 explain the additional extensions to the INI format.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 The file syntax has following rules:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 .Bl -enum
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 Each option is stored in a section,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 Some sections may be redefined multiple times,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 Empty option must have quotes (e.g. option = "").
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 .Ss The @include and @tryinclude statements
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 Irccd adds an extension to this format by adding an
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 .\" @include and @tryinclude
874
bf2bdb41f181 doc: improve doxygen documentation
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
44 .Ar @include keyword
bf2bdb41f181 doc: improve doxygen documentation
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
45 which let you splitting your configuration file.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 Note: this @include statement must be at the beginning of the file and must be
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
48 surrounded by quotes if the file name has spaces.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 You can use both relative or absolute paths. If relative paths are used, they
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 are relative to the current file being parsed.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 The alternative
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 .Ar @tryinclude
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 keyword is similar but does not fails if the requested file is not found.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 Example of includes:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 @include "rules.conf"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 @include "servers.conf"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
61
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 [mysection]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 myoption = "1"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 .\" lists
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
66 .Ss The list construct
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 When requested, an option can have multiples values in a list. The syntax uses
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
68 parentheses and values are separated by commas.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 If the list have only one value, you can just use a simple string.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
71 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 Example of lists:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
74 [rule]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
75 servers = ( "server1", "server2" )
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
76
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
77 [rule]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
78 servers = "only-one-server"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
79 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
80 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
81 Note: spaces are completely optional.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
82 .\" identifiers
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
83 .Ss Identifiers
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
84 Some sections require an identifier (specified as id) as parameter. They must be
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
85 unique, not empty and can only contain characters, numbers, '-' and '_'.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
86 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
87 Example: both
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
88 .Ar abc
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
89 and
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
90 .Ar server-tz2
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
91 are valid.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
92 .\" CONFIGURATION SECTIONS
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
93 .Sh CONFIGURATION SECTIONS
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
94 Configuration are always stored in dedicated section in the form
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
95 .Ar [name]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
96 where name is one of the section defined below and are case-sensitive.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
97 .\" [logs]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
98 .Ss logs
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
99 This section can let you configure how irccd should log the messages.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
100 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
101 Available options:
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
102 .Bl -tag -width 20n
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
103 .It Va verbose No (bool)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
104 Be verbose (Optional, default: false).
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
105 .It Va type No (string)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
106 Which kind of logging, valid values are
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
107 .Dq console ,
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
108 .Dq file
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
109 or
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
110 .Dq syslog
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
111 (Optional, default: console).
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
112 .Pp
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
113 Note: syslog is not available on all platforms.
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
114 .El
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
115 .Pp
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
116 The following options are available for the
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
117 .Ar file
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
118 type:
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
119 .Bl -tag -width 20n
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
120 .It Va path-logs No (string)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
121 Path to the normal messages.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
122 .It Va path-errors No (string)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
123 Path to the error messages.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
124 .El
847
a23b7b574ed2 irccd: rename [format] section to [templates], closes #1671
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
125 .\" [templates]
a23b7b574ed2 irccd: rename [format] section to [templates], closes #1671
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
126 .Ss templates
a23b7b574ed2 irccd: rename [format] section to [templates], closes #1671
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
127 The templates section let you change the irccd's output. It uses the templates
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
128 system (see
847
a23b7b574ed2 irccd: rename [format] section to [templates], closes #1671
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
129 .Xr irccd-templates 7
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
130 for more information about templates)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
131 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
132 Only one keyword is defined, message which contains the message that irccd
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
133 wants to output.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
134 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
135 Note: colors and attributes are not supported on Windows.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
136 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
137 Available options:
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
138 .Bl -tag -width 18n
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
139 .It Va debug No (string)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
140 Template to use to format debug messages (Optional, default: none).
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
141 .It Va info No (string)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
142 Template to use to format information messages (Optional, default: none).
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
143 .It Va warning No (string)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
144 Template to use to format warnings (Optional, default: none).
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
145 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
146 .\" [server]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
147 .Ss server
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
148 This section is used to connect to one or more server. Create a new server
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
149 section for each IRC server you want to connect to.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
150 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
151 Available options:
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
152 .Bl -tag -width 26n
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
153 .It Va name No (identifier)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
154 The unique id.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
155 .It Va hostname No (string)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
156 The server address or IP.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
157 .It Va port No (int)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
158 The server port (Optional, default: 6667).
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
159 .It Va password No (string)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
160 An optional server password (Optional, default: none).
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
161 .It Va join-invite No (bool)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
162 Automatically join channels upon invitation (Optional, default: false).
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
163 .It Va channels No (list)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
164 List of channels to auto join (Optional, default: empty).
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
165 .Pp
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
166 Note: if a channel requires a password, add it after a colon (e.g.
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
167 .Dq #channel:password ) .
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
168 .It Va command-char No (string)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
169 The prefix for invoking special commands (Optional, default: !).
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
170 .It Va ssl No (bool)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
171 Enable or disable SSL (Optional, default: false).
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
172 .It Va auto-reconnect No (bool)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
173 Enable reconnection after failure (Optional, default: true).
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
174 .It Va auto-reconnect-delay No (int)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
175 Number of seconds to wait before retrying (Optional, default: 30).
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
176 .It Va ping-timeout No (int)
925
d585adeee610 irccd: enable auto-reconnect by default as specified in manual page
David Demelier <markand@malikania.fr>
parents: 924
diff changeset
177 Number of seconds before ping timeout (Optional, default: 1800).
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
178 .It Va nickname No (string)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
179 The nickname (Optional, default: irccd).
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
180 .It Va realname No (string)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
181 The realname (Optional, default: IRC Client Daemon).
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
182 .It Va username No (string)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
183 The username name (Optional, default: irccd).
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
184 .It Va ctcp-version No (string)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
185 What version to respond to CTCP VERSION (Optional, default: IRC Client Daemon).
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
186 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
187 .\" [paths]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
188 .Ss paths
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
189 The paths section defines common paths used as defaults for all plugins.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
190 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
191 Any option in this section can be defined altough the following are used as
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
192 common convention used in all plugins:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
193 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
194 Available options:
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
195 .Bl -tag -width 16n
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
196 .It Va cache No (string)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
197 Path for data files written by the plugin.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
198 .It Va data No (string)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
199 Path for data files provided by the user.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
200 .It Va config No (string)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
201 Path for additional configuration from the user.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
202 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
203 .Pp
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
204 For each of these paths,
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
205 .Dq plugin/name
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
206 is appended with the appropriate plugin name when used.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
207 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
208 The section is redefinable per plugin basis using the
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
209 .Va [paths.<plugin>]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
210 syntax.
895
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 884
diff changeset
211 .\" [plugins]
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
212 .Ss plugins
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
213 This section is used to load plugins.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
214 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
215 Just add any key you like to load a plugin. If the value is not specified, the
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
216 plugin is searched through the standard directories, otherwise, provide the full
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
217 path (including the .js extension).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
218 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
219 Warning: remember to add an empty string for searching plugins.
895
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 884
diff changeset
220 .\" [hooks]
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 884
diff changeset
221 .Ss hooks
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 884
diff changeset
222 This sections stores every hooks in key-value pairs. The option key denotes the
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 884
diff changeset
223 hook id and the value must be a path to the actual hook file.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
224 .\" [transport]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
225 .Ss transport
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
226 This section defines transports that are used to communicate through clients
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
227 connected to irccd and to perform requests to irccd.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
228 .Pp
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
229 With transports, you may ask irccd to send a message, a notice or even to kick
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
230 someone from a channel. Irccd will also notify all clients connected to this
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
231 transport on IRC events.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
232 .Pp
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
233 There are two types of transport availables:
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
234 .Bl -bullet
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
235 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
236 Internet sockets, IPv4 and IPv6,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
237 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
238 Unix sockets, based on files (not available on Windows).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
239 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
240 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
241 If SSL support was built in, both internet and unix sockets can be set to use
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
242 encrypted connections.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
243 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
244 Available options:
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
245 .Bl -tag -width 18n
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
246 .It Va type No (string)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
247 Type of transport
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
248 .Dq ip
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
249 or
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
250 .Dq unix .
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
251 .It Va password No (string)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
252 An authentication password (Optional, default: none).
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
253 .It Va ssl No (bool)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
254 Enable SSL (Optional, default: false),
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
255 .It Va key No (string)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
256 Path to private key file (Required if ssl is true)
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
257 .It Va certificate No (string)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
258 Path to certificate (Required if ssl is true)
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
259 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
260 .Pp
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
261 The following options are available for the
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
262 .Ar ip
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
263 type:
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
264 .Bl -tag -width 18n
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
265 .It Va port No (int)
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
266 Port number.
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
267 .It Va address No (string)
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
268 Address to bind or
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
269 .Dq *
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
270 for any (Optional, default:
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
271 .Dq * ) .
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
272 .It Va ipv4 No (bool)
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
273 Bind on IPv4 (Optional, default true).
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
274 .It Va ipv6 No (bool)
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
275 Bind on IPv6 (Optional, default true).
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
276 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
277 .Pp
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
278 The following options are available for the
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
279 .Ar unix
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
280 type:
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
281 .Bl -tag -width 18n
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
282 .It Va path No (string)
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
283 The file path to the socket.
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
284 .El
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
285 .\" [rule]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
286 .Ss rule
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
287 The rule section is one of the most powerful within irccd configuration. It lets
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
288 you enable or disable plugins and IRC events for specific criterias. For
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
289 instance, you may want to disable a plugin only for a specific channel on a
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
290 specific server. And because rules are evaluated in the order they are defined,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
291 you can override rules.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
292 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
293 Available options:
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
294 .Bl -tag -width 15n
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
295 .It Va servers No (list)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
296 A list of servers that will match the rule (Optional, default: empty).
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
297 .It Va channels No (list)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
298 A list of channel (Optional, default: empty).
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
299 .It Va origins No (list)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
300 A list of nicknames to check (Optional, default: empty).
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
301 .It Va plugins No (list)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
302 Which plugins (Optional, default: empty),
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
303 .It Va events No (list)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
304 Which events like onCommand, onMessage (Optional, default: empty).
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
305 .It Va action No (string)
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
306 Set to
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
307 .Dq accept
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
308 or
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
309 .Dq drop .
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
310 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
311 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
312 Warning: don't make sensitive rules on origins option, irccd does not have any
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
313 kind of nickname authentication. Thus, it may be very easy for someone
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
314 to use a temporary nickname.
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
315 .\" EXAMPLES
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
316 .Sh EXAMPLES
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
317 Full example of configuration file
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
318 .Bd -literal
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
319 # Add a transport that bind only to IPv6.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
320 [transport]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
321 type = ip
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
322 ipv4 = false
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
323 ipv6 = true
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
324 port = 12000
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
325
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
326 # A transport that binds to both IPv4 and IPv6.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
327 [transport]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
328 type = ip
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
329 port = 15000
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
330
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
331 # A server.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
332 [server]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
333 name = "foo"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
334 host = "irc.foo.org"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
335 port = "6667"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
336 nickname = "superbot"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
337 realname = "SuperBot v1.0"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
338 username = "sp"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
339
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
340 # An other server.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
341 [server]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
342 name = "wanadoo"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
343 host = "chat.wanadoo.fr"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
344 port = "6667"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
345
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
346 # Load some plugins.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
347 [plugins]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
348 ask = "" # Search ask
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
349 myplugin = /path/to/myplugin.js # Use absolute path
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
350
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
351 # This first rule disable the plugin reboot on all servers and channels.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
352 [rule]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
353 plugins = "reboot"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
354 action = drop
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
355
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
356 # This rule enable the reboot plugin again on the server localhost,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
357 # channel #staff.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
358 [rule]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
359 servers = "localhost"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
360 channels = "#staff"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
361 plugins = "reboot"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
362 action = accept
895
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 884
diff changeset
363
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 884
diff changeset
364 # Example of hooks
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 884
diff changeset
365 # This create an hook named "mail" with the given path.
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 884
diff changeset
366 [hooks]
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 884
diff changeset
367 mail = "/path/to/mail.py"
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
368 .Ed
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
369 .\" SEE ALSO
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
370 .Sh SEE ALSO
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
371 .Xr irccd 1
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
372 .\" AUTHORS
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
373 .Sh AUTHORS
906
b831d9f48b0e doc: fix various errors
David Demelier <markand@malikania.fr>
parents: 884
diff changeset
374 .Nm irccd
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
375 was written by David Demelier <markand@malikania.fr>