Mercurial > irccd

annotate doc/procs/30.options.md @ 76:7e9a1faeb6f6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
CMake: temporarily disable CMake export as it requires Ph.D
author David Demelier <markand@malikania.fr>
date Wed, 30 Mar 2016 14:17:23 +0200
parents fe9854a09ee7
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
55
fe9854a09ee7 Misc: switch CRLF -> LF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
1 Irccdctl configuration file (irccdctl.conf)
fe9854a09ee7 Misc: switch CRLF -> LF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
2 ===========================================
fe9854a09ee7 Misc: switch CRLF -> LF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
3
fe9854a09ee7 Misc: switch CRLF -> LF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
4 This file describes how to add new options in the irccdctl configuration file.
fe9854a09ee7 Misc: switch CRLF -> LF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
5
fe9854a09ee7 Misc: switch CRLF -> LF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
6 # Current options
fe9854a09ee7 Misc: switch CRLF -> LF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
7
fe9854a09ee7 Misc: switch CRLF -> LF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
8 ## general
fe9854a09ee7 Misc: switch CRLF -> LF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
9
fe9854a09ee7 Misc: switch CRLF -> LF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
10 - **verbose**: (bool) enable verbose message (Optional, default: false).
fe9854a09ee7 Misc: switch CRLF -> LF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
11
fe9854a09ee7 Misc: switch CRLF -> LF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
12 ## connect
fe9854a09ee7 Misc: switch CRLF -> LF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
13
fe9854a09ee7 Misc: switch CRLF -> LF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
14 - **type**: (string) type of listener "ip" or "unix".
fe9854a09ee7 Misc: switch CRLF -> LF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
15
fe9854a09ee7 Misc: switch CRLF -> LF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
16 The options for **internet** type:
fe9854a09ee7 Misc: switch CRLF -> LF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
17
fe9854a09ee7 Misc: switch CRLF -> LF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
18 - **host**: (string) host to connect,
fe9854a09ee7 Misc: switch CRLF -> LF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
19 - **port**: (int) port number,
fe9854a09ee7 Misc: switch CRLF -> LF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
20 - **family**: (string) internet family: ipv6 or ipv4 (Optional, default: ipv4).
fe9854a09ee7 Misc: switch CRLF -> LF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
21
fe9854a09ee7 Misc: switch CRLF -> LF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
22 The options for **unix** type:
fe9854a09ee7 Misc: switch CRLF -> LF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
23
fe9854a09ee7 Misc: switch CRLF -> LF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
24 - **path**: (string) the file path to the socket.