Mercurial > irccd

annotate doc/html/index.md @ 715:f3709544d0d1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
CMake: s/libcommon/libirccd-core in tests
author David Demelier <markand@malikania.fr>
date Mon, 09 Jul 2018 21:10:00 +0200
parents e5d0f4289e04
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
260
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 ---
276
5795a1769de5 Docs: add more indexes
David Demelier <markand@malikania.fr>
parents: 275
diff changeset
2 header: "Irccd documentation"
260
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 guide: true
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 ---
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
5
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 Welcome to the irccd documentation.
275
c143682678b9 CMake: improve documentation related to plugins
David Demelier <markand@malikania.fr>
parents: 260
diff changeset
7
c143682678b9 CMake: improve documentation related to plugins
David Demelier <markand@malikania.fr>
parents: 260
diff changeset
8 # Building
c143682678b9 CMake: improve documentation related to plugins
David Demelier <markand@malikania.fr>
parents: 260
diff changeset
9
276
5795a1769de5 Docs: add more indexes
David Demelier <markand@malikania.fr>
parents: 275
diff changeset
10 Everything you need to build irccd.
5795a1769de5 Docs: add more indexes
David Demelier <markand@malikania.fr>
parents: 275
diff changeset
11
275
c143682678b9 CMake: improve documentation related to plugins
David Demelier <markand@malikania.fr>
parents: 260
diff changeset
12 - [Build from sources](build/build-from-sources.html)
c143682678b9 CMake: improve documentation related to plugins
David Demelier <markand@malikania.fr>
parents: 260
diff changeset
13 - [Build options](build/build-options.html)
c143682678b9 CMake: improve documentation related to plugins
David Demelier <markand@malikania.fr>
parents: 260
diff changeset
14
378
46e9ecf974a5 Docs: improve index page
David Demelier <markand@malikania.fr>
parents: 370
diff changeset
15 # Configuring & running
275
c143682678b9 CMake: improve documentation related to plugins
David Demelier <markand@malikania.fr>
parents: 260
diff changeset
16
378
46e9ecf974a5 Docs: improve index page
David Demelier <markand@malikania.fr>
parents: 370
diff changeset
17 ## General topics
46e9ecf974a5 Docs: improve index page
David Demelier <markand@malikania.fr>
parents: 370
diff changeset
18
46e9ecf974a5 Docs: improve index page
David Demelier <markand@malikania.fr>
parents: 370
diff changeset
19 Read the following sections to understand the configuration file format and in
46e9ecf974a5 Docs: improve index page
David Demelier <markand@malikania.fr>
parents: 370
diff changeset
20 which directories they are located.
276
5795a1769de5 Docs: add more indexes
David Demelier <markand@malikania.fr>
parents: 275
diff changeset
21
368
d731ce3ae821 Docs: add new documentation about paths
David Demelier <markand@malikania.fr>
parents: 276
diff changeset
22 - [Paths](irccd/paths.html)
378
46e9ecf974a5 Docs: improve index page
David Demelier <markand@malikania.fr>
parents: 370
diff changeset
23 - [Configuration file syntax](misc/configuration-syntax.html)
46e9ecf974a5 Docs: improve index page
David Demelier <markand@malikania.fr>
parents: 370
diff changeset
24
46e9ecf974a5 Docs: improve index page
David Demelier <markand@malikania.fr>
parents: 370
diff changeset
25 ## Irccd
46e9ecf974a5 Docs: improve index page
David Demelier <markand@malikania.fr>
parents: 370
diff changeset
26
46e9ecf974a5 Docs: improve index page
David Demelier <markand@malikania.fr>
parents: 370
diff changeset
27 Configure and run `irccd` daemon.
46e9ecf974a5 Docs: improve index page
David Demelier <markand@malikania.fr>
parents: 370
diff changeset
28
275
c143682678b9 CMake: improve documentation related to plugins
David Demelier <markand@malikania.fr>
parents: 260
diff changeset
29 - [Configure irccd](irccd/configuring.html)
380
edd873d583eb Docs: improve irccd and irccdctl documentation
David Demelier <markand@malikania.fr>
parents: 378
diff changeset
30 - [Irccd command line usage](irccd/usage.html)
276
5795a1769de5 Docs: add more indexes
David Demelier <markand@malikania.fr>
parents: 275
diff changeset
31
378
46e9ecf974a5 Docs: improve index page
David Demelier <markand@malikania.fr>
parents: 370
diff changeset
32 ## Irccdctl
46e9ecf974a5 Docs: improve index page
David Demelier <markand@malikania.fr>
parents: 370
diff changeset
33
46e9ecf974a5 Docs: improve index page
David Demelier <markand@malikania.fr>
parents: 370
diff changeset
34 Everything about the `irccdctl` utility.
276
5795a1769de5 Docs: add more indexes
David Demelier <markand@malikania.fr>
parents: 275
diff changeset
35
275
c143682678b9 CMake: improve documentation related to plugins
David Demelier <markand@malikania.fr>
parents: 260
diff changeset
36 - [Configure irccdctl](irccdctl/configuring.html)
370
a60142be369a Docs: improve headers
David Demelier <markand@malikania.fr>
parents: 369
diff changeset
37 - [Irccdctl command line usage](irccdctl/usage.html)
390
2df0f202946c Docs: update broken links for irccdctl commands
David Demelier <markand@malikania.fr>
parents: 380
diff changeset
38 - [List of irccdctl commands](irccdctl/command/index.html)
275
c143682678b9 CMake: improve documentation related to plugins
David Demelier <markand@malikania.fr>
parents: 260
diff changeset
39
369
5aca8eeebcf1 Docs: list plugins in index
David Demelier <markand@malikania.fr>
parents: 368
diff changeset
40 # Plugins
5aca8eeebcf1 Docs: list plugins in index
David Demelier <markand@malikania.fr>
parents: 368
diff changeset
41
5aca8eeebcf1 Docs: list plugins in index
David Demelier <markand@malikania.fr>
parents: 368
diff changeset
42 Documentation about official irccd plugins.
5aca8eeebcf1 Docs: list plugins in index
David Demelier <markand@malikania.fr>
parents: 368
diff changeset
43
5aca8eeebcf1 Docs: list plugins in index
David Demelier <markand@malikania.fr>
parents: 368
diff changeset
44 - [ask](plugin/ask.html)
5aca8eeebcf1 Docs: list plugins in index
David Demelier <markand@malikania.fr>
parents: 368
diff changeset
45 - [auth](plugin/auth.html)
5aca8eeebcf1 Docs: list plugins in index
David Demelier <markand@malikania.fr>
parents: 368
diff changeset
46 - [hangman](plugin/hangman.html)
5aca8eeebcf1 Docs: list plugins in index
David Demelier <markand@malikania.fr>
parents: 368
diff changeset
47 - [history](plugin/history.html)
5aca8eeebcf1 Docs: list plugins in index
David Demelier <markand@malikania.fr>
parents: 368
diff changeset
48 - [logger](plugin/logger.html)
5aca8eeebcf1 Docs: list plugins in index
David Demelier <markand@malikania.fr>
parents: 368
diff changeset
49 - [plugin](plugin/plugin.html)
5aca8eeebcf1 Docs: list plugins in index
David Demelier <markand@malikania.fr>
parents: 368
diff changeset
50 - [roulette](plugin/roulette.html)
632
e5d0f4289e04 Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents: 390
diff changeset
51 - [tictactoe](plugin/tictactoe.html)
369
5aca8eeebcf1 Docs: list plugins in index
David Demelier <markand@malikania.fr>
parents: 368
diff changeset
52
276
5795a1769de5 Docs: add more indexes
David Demelier <markand@malikania.fr>
parents: 275
diff changeset
53 # Development
5795a1769de5 Docs: add more indexes
David Demelier <markand@malikania.fr>
parents: 275
diff changeset
54
5795a1769de5 Docs: add more indexes
David Demelier <markand@malikania.fr>
parents: 275
diff changeset
55 Development of plugins and other development documentation.
275
c143682678b9 CMake: improve documentation related to plugins
David Demelier <markand@malikania.fr>
parents: 260
diff changeset
56
c143682678b9 CMake: improve documentation related to plugins
David Demelier <markand@malikania.fr>
parents: 260
diff changeset
57 - [Javascript plugin introduction](dev/plugin-javascript-introduction.html)
276
5795a1769de5 Docs: add more indexes
David Demelier <markand@malikania.fr>
parents: 275
diff changeset
58 - [Network protocol](dev/socket-protocol.html)
5795a1769de5 Docs: add more indexes
David Demelier <markand@malikania.fr>
parents: 275
diff changeset
59 - [Network commands](dev/socket-commands.html)
5795a1769de5 Docs: add more indexes
David Demelier <markand@malikania.fr>
parents: 275
diff changeset
60
5795a1769de5 Docs: add more indexes
David Demelier <markand@malikania.fr>
parents: 275
diff changeset
61 # Plugin API
5795a1769de5 Docs: add more indexes
David Demelier <markand@malikania.fr>
parents: 275
diff changeset
62
5795a1769de5 Docs: add more indexes
David Demelier <markand@malikania.fr>
parents: 275
diff changeset
63 The official Javascript API.
5795a1769de5 Docs: add more indexes
David Demelier <markand@malikania.fr>
parents: 275
diff changeset
64
275
c143682678b9 CMake: improve documentation related to plugins
David Demelier <markand@malikania.fr>
parents: 260
diff changeset
65 - [Javascript API](api/index.html)
c143682678b9 CMake: improve documentation related to plugins
David Demelier <markand@malikania.fr>
parents: 260
diff changeset
66
c143682678b9 CMake: improve documentation related to plugins
David Demelier <markand@malikania.fr>
parents: 260
diff changeset
67 # Miscellaneous
c143682678b9 CMake: improve documentation related to plugins
David Demelier <markand@malikania.fr>
parents: 260
diff changeset
68
276
5795a1769de5 Docs: add more indexes
David Demelier <markand@malikania.fr>
parents: 275
diff changeset
69 Miscellaneous documentation.
5795a1769de5 Docs: add more indexes
David Demelier <markand@malikania.fr>
parents: 275
diff changeset
70
275
c143682678b9 CMake: improve documentation related to plugins
David Demelier <markand@malikania.fr>
parents: 260
diff changeset
71 - [Common patterns and formatting](misc/common-patterns-and-formatting.html)