diff options
author | Sergey Poznyakoff <gray@gnu.org.ua> | 2011-05-09 00:18:34 +0300 |
---|---|---|
committer | Sergey Poznyakoff <gray@gnu.org.ua> | 2011-05-09 00:18:34 +0300 |
commit | c9bb1bdfd12dce4d20375e6bd3bf6d41417191d8 (patch) | |
tree | 5039c88670bfa2596151ca467f75df7cec030503 /README.standalone | |
parent | e523423777dd75acc59cf7b9e7466527d774a9f9 (diff) | |
download | grecs-c9bb1bdfd12dce4d20375e6bd3bf6d41417191d8.tar.gz grecs-c9bb1bdfd12dce4d20375e6bd3bf6d41417191d8.tar.bz2 |
Write README files.
Diffstat (limited to 'README.standalone')
-rw-r--r-- | README.standalone | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/README.standalone b/README.standalone new file mode 100644 index 0000000..c59d61c --- /dev/null +++ b/README.standalone | |||
@@ -0,0 +1,73 @@ | |||
1 | Grecs README | ||
2 | Copyright (C) 2011 Sergey Poznyakoff | ||
3 | See the end of file for copying conditions. | ||
4 | |||
5 | * Introduction | ||
6 | |||
7 | This file contains brief information about configuring, testing | ||
8 | and installing Grecs library. It is *not* intended as a replacement | ||
9 | for the documentation, and is provided as a brief reference only. | ||
10 | The complete documentation for Grecs is available in the | ||
11 | doc/ subdirectory, both as a set of manpages and as texinfo | ||
12 | documents. To access the latter without installing the package | ||
13 | run `info -f doc/grecs.info'. After the package is installed | ||
14 | the documentation can be accessed by running `info grecs'. | ||
15 | |||
16 | An online copy of the documentation in various formats is available | ||
17 | at http://grecs.man.gnu.org.ua. | ||
18 | |||
19 | * Overview | ||
20 | |||
21 | Grecs is a library for parsing structured configuration files from | ||
22 | C programs. A structured configuration file has hierarchical | ||
23 | structure, with block statements enclosing lower-level | ||
24 | statements. Such configurations files are used by many programs, such | ||
25 | as, e.g. Bind or Dico. | ||
26 | |||
27 | Grecs provides primitives for parsing such files into an internal | ||
28 | tree-like structure and for basic operations on such structures. These | ||
29 | operations include value lookups by keyword paths, traversing trees | ||
30 | recursively, joining several trees together, reductions, etc. | ||
31 | |||
32 | * Downloads | ||
33 | |||
34 | New versions of Libgrecs are available for download from | ||
35 | |||
36 | ftp://download.gnu.org.ua/pub/release/grecs | ||
37 | |||
38 | * Building | ||
39 | |||
40 | The usual build rules apply: | ||
41 | |||
42 | ./configure [OPTIONS] | ||
43 | make | ||
44 | make install | ||
45 | |||
46 | For generic installation instructions, including a discussion of | ||
47 | available [OPTIONS], see the file INSTALL in this directory. | ||
48 | |||
49 | * Bug reporting. | ||
50 | |||
51 | Send bug reports to <gray+grecs@gnu.org.ua>. | ||
52 | |||
53 | |||
54 | * Copyright information: | ||
55 | |||
56 | Copyright (C) 2011 Sergey Poznyakoff | ||
57 | |||
58 | Permission is granted to anyone to make or distribute verbatim copies | ||
59 | of this document as received, in any medium, provided that the | ||
60 | copyright notice and this permission notice are preserved, | ||
61 | thus giving the recipient permission to redistribute in turn. | ||
62 | |||
63 | Permission is granted to distribute modified versions | ||
64 | of this document, or of portions of it, | ||
65 | under the above conditions, provided also that they | ||
66 | carry prominent notices stating who last changed them. | ||
67 | |||
68 | |||
69 | Local Variables: | ||
70 | mode: outline | ||
71 | paragraph-separate: "[ ]*$" | ||
72 | version-control: never | ||
73 | End: | ||