README
1Grecs README
2Copyright (C) 2011-2012 Sergey Poznyakoff
3See the end of file for copying conditions.
4
5* Introduction
6
7This file contains brief information about using Grecs as a submodule.
8You will find a complete documentation for Grecs, in form of man
9pages, in the doc/ subdirectory.
10
11An online copy of the documentation in various formats is available
12at http://grecs.man.gnu.org.ua.
13
14If you are interested in libgrecs, a standalone library implementation
15of Grecs, see the file README.standalone in this directory, or visit
16http://grecs.man.gnu.org.ua.
17
18* Overview
19
20Grecs is a library for parsing structured configuration files from
21C programs. A structured configuration file has hierarchical
22structure, with block statements enclosing lower-level
23statements. Such configurations files are used by many programs, such
24as, e.g. Bind or Dico.
25
26Grecs provides primitives for parsing such files into an internal
27tree-like structure and for basic operations on such structures. These
28operations include value lookups by keyword paths, traversing trees
29recursively, joining several trees together, reductions, etc.
30
31* Usage
32
331. Install grecs as a submodule:
34
35 git submodule add git://git.gnu.org.ua/grecs.git grecs
36
372. Add a call to GRECS_SETUP to your configure.ac. It can be as
38simple as:
39
40 GRECS_SETUP
41
42If the subproject directory is not 'grecs', supply the actual
43directory name as the first argument to this macro, e.g.:
44
45 GRECS_SETUP(lib/grecs)
46
47For a detailed description of the GRECS_SETUP macro, run
48`man doc/GRECS_SETUP.3'.
49
503. In your Makefile.am, add @GRECS_INCLUDES@ to the INCLUDES value,
51and @GRECS_LDADD@ to LDADD, e.g.:
52
53 INCLUDES = @GRECS_INCLUDES@
54 LDADD = @GRECS_LDADD@
55
564. Include "grecs.h"
57
585. Use the library to handle your configuration files. See the
59documentation for a detailed discussion.
60
61* Bug reporting.
62
63Send bug reports to <gray+grecs@gnu.org.ua>.
64
65
66* Copyright information:
67
68Copyright (C) 2011 Sergey Poznyakoff
69
70 Permission is granted to anyone to make or distribute verbatim copies
71 of this document as received, in any medium, provided that the
72 copyright notice and this permission notice are preserved,
73 thus giving the recipient permission to redistribute in turn.
74
75 Permission is granted to distribute modified versions
76 of this document, or of portions of it,
77 under the above conditions, provided also that they
78 carry prominent notices stating who last changed them.
79
80
81Local Variables:
82mode: outline
83paragraph-separate: "[ ]*$"
84version-control: never
85End:
86