Mercurial > irccd

annotate doc/html/api/module/Irccd.Server/method/constructor.md @ 254:93a227277786

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Irccd: various fixes for further cross-compilation
author David Demelier <markand@malikania.fr>
date Mon, 05 Sep 2016 12:53:13 +0200
parents 6635b9187d71
children 904ee87bc808
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 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 method: constructor
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 summary: "Construct a new server"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 synopsis: "Irccd.Server(params) /* constructor */"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 arguments:
24
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
6 - "**params**: parameters."
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 The params argument may have the following properties:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10
24
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
11 - **name**: the name,
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
12 - **host**: the host,
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
13 - **ipv6**: true to use ipv6, (Optional: default false)
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
14 - **port**: the port number, (Optional: default 6667)
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
15 - **password**: the password, (Optional: default none)
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
16 - **channels**: array of channels (Optiona: default empty)
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
17 - **ssl**: true to use ssl, (Optional: default false)
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
18 - **sslVerify**: true to verify (Optional: default true)
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
19 - **nickname**: "nickname", (Optional, default: irccd)
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
20 - **username**: "user name", (Optional, default: irccd)
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
21 - **realname**: "real name", (Optional, default: IRC Client Daemon)
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
22 - **commandChar**: "!", (Optional, the command char, default: "!")
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
23
24
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
24 ## Example
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
25
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 ````javascript
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 var s = new Irccd.Server({
207
6635b9187d71 Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents: 24
diff changeset
28 name: "localhost",
6635b9187d71 Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents: 24
diff changeset
29 host: "localhost",
6635b9187d71 Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents: 24
diff changeset
30 nickname: "kevin",
6635b9187d71 Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents: 24
diff changeset
31 ssl: true,
6635b9187d71 Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents: 24
diff changeset
32 sslVerify: false
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 });
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 ````