annotate doc/html/guide/03-config-format/01-basics.md @ 20:8384df86e195

Docs: use nohighlight on non code, #418
author David Demelier <markand@malikania.fr>
date Fri, 12 Feb 2016 16:12:58 +0100
parents 1158cffe5a5e
children
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 # Configuration file format
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 Both `irccd` and `irccdctl` use configuration file in a extended [INI][ini] format.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 ## General syntax
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 The file syntax has following rules:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8
20
8384df86e195 Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
9 1. Each option is stored in a section,
8384df86e195 Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
10 2. Some sections may be redefined multiple times,
8384df86e195 Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
11 3. Empty option must have quotes (e.g. `option = ""`).
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 [ini]: https://en.wikipedia.org/wiki/INI_file