Imported Upstream version 1.4.0
[platform/upstream/augeas.git] / README.md
1 Introduction
2 ------------
3
4   Augeas is a library and command line tool that focuses on the most basic
5   problem in handling Linux configurations programmatically: editing actual
6   configuration files in a controlled manner.
7
8   To that end, Augeas exposes a tree of all configuration settings (well,
9   all the ones it knows about) and a simple local API for manipulating the
10   tree. Augeas then modifies underlying configuration files according to
11   the changes that have been made to the tree; it does as little modeling
12   of configurations as possible, and focuses exclusivley on transforming
13   the tree-oriented syntax of its public API to the myriad syntaxes of
14   individual configuration files.
15
16   This focus on editing sets Augeas apart from any other configuration tool
17   I know of. Hopefully, Augeas will form a more solid foundation on which
18   these tools can be built; with a clean, simple API these tools should
19   be able to focus more on their core concerns and less on the mechanics
20   of running sed, grep, awk, etc. to tweak a config file.
21
22   If all you need is a tool to edit configuration files, you only need to
23   concern yourself with the handful of public API calls that Augeas exposes
24   (or their equivalent language bindings). However, to teach Augeas about a
25   new file format, you need to describe that file format in Augeas's domain
26   specific language (a very small subset of ML) Documentation for that
27   language can be found on the Augeas website at http://augeas.net/ If you
28   do that, please contribute the description if at all possible, or include
29   it in the distribution of your software - all you need to do for that is
30   add a couple of text files, there is no need to change existing
31   code. Ultimately, Augeas should describe all config files commonly found
32   on a Linux system.
33
34 Non-goals
35 ---------
36
37 Augeas is as much defined by the things it does _not_ try to accomplish
38 as by its goals:
39
40 * No abstraction from native config format, i.e. the organization of
41   the tree mirrors closely how the native config files are organized
42 * No cross-platform abstraction - what is logically the same value may
43   live in different places in the tree on different
44   distributions. Dealing with that should be left to a higher-level
45   tool
46 * No remote management support. Augeas is a local API, other ways of
47   access to Augeas should be built on top of it
48 * No (or very little) modelling. Augeas is focused on syntax
49   transformation, not on any higher-level understanding of
50   configuration.
51
52 The above non-goals are of course important concerns in
53 practice. Historically though, too many config mgmt projects have failed
54 because they set their sights too high and tried to address syntax
55 transformation, modelling, remote support, and scalable management all in
56 one. That leads to a lack of focus, and to addressing each of those goals
57 unsatisfactorily.
58
59 Building
60 --------
61
62 These instructions apply to building a released tarball. If you want to
63 build from a git checkout, see the file HACKING.
64
65 See the generic instructions in INSTALL. Generally,
66
67       ./configure
68       make && make install
69 should be all that is needed.
70
71 You need to have readline-devel installed. On systems that support
72 SELinux, you should also install libselinux-devel.
73
74 Documentation
75 -------------
76
77 Documentation can be found on Augeas' website http://augeas.net/ The site
78 also contains information on how to get in touch, what you can do to help
79 etc.
80
81 License
82 -------
83
84 Augeas is released under the [Lesser General Public License, Version 2.1](http://www.gnu.org/licenses/lgpl-2.1.html)
85 See the file COPYING for details.