summaryrefslogtreecommitdiff
path: root/README
blob: e4eaf5f431d40e66efa5d8b213d9ec37de9f0cbe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
Configuration Language Organised (by) Dots
==========================================

Clod is a simple dotted configuration language where configuration files
contain key/value pairs.  Each key is entered into a dotted heirarchy such that
the application using Clod can query groups of elements, iterate pairs, etc.

An example Clod configuration file might be:

    -------8<--------
    project.name "Clod"
    project.description "Configuration language Organised (by) Dots"
    project.head "refs/heads/master"
    
    cia.project "lua-clod"
    
    commit.maillist "clod-commits@gitano.org.uk"
    commit.devlist "clod-dev@gitano.org.uk"
    -------8<--------

Note that blank lines are permitted, but otherwise there is no supported
comment syntax.  Since Clod files are interpreted as Lua files by the current
Clod implementation, you *can* make comments of the form `-- this is a comment`
however this is not guaranteed and cannot be maintained by the library if you
use Clod's ability to rewrite configuration files.