Mercurial > irccd

annotate doc/procs/30.options.md @ 15:8d74eeb81184

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Docs: update documentation in the irccd JavaScript events
author David Demelier <markand@malikania.fr>
date Thu, 11 Feb 2016 13:48:53 +0100
parents 1158cffe5a5e
children fe9854a09ee7
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 configuration file (irccdctl.conf)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 ===========================================
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 This file describes how to add new options in the irccdctl configuration file.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 # Current options
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 ## general
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 - **verbose**: (bool) enable verbose message (Optional, default: false).
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 ## connect
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 - **type**: (string) type of listener "ip" or "unix".
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 The options for **internet** type:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 - **host**: (string) host to connect,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 - **port**: (int) port number,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 - **family**: (string) internet family: ipv6 or ipv4 (Optional, default: ipv4).
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 The options for **unix** type:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
23
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 - **path**: (string) the file path to the socket.