annotate doc/html/guide/03-config-format/02-include.md @ 213:68831a43b1ab

Irccd: move the config and format property names in JsPlugin
author David Demelier <markand@malikania.fr>
date Thu, 23 Jun 2016 12:49:59 +0200
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 ## The @include statement
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 Irccd adds an extension to this format by adding an `@include` keyword which let you splitting your configuration file.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 <div class="alert alert-info" role="alert">
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 **Note:** this `@include` statement must be at the beginning of the file and must be surrounded by quotes if the file
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 name has spaces.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 </div>
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 You can use both relative or absolute paths. If relative paths are used, they are relative to the current file being
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 parsed.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 ### Example
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 ````ini
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 @include "rules.conf"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 @include "servers.conf"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 [mysection]
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 myoption = "1"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 ````