xref: /aosp_15_r20/external/libconfig/docs/index.md (revision 2e9d491483b805f09ea864149eadd5680efcc72a)
1## About
2
3*Libconfig* is a simple library for processing structured configuration
4files, like [this one](test.cfg.txt). This file format is more compact
5and more readable than XML. And unlike XML, it is type-aware, so it is
6not necessary to do string parsing in application code.
7
8*Libconfig* is very compact -- a fraction of the size of the _expat_ XML
9parser library. This makes it well-suited for memory-constrained systems
10like handheld devices.
11
12The library includes bindings for both the C and C++ languages. It works
13on POSIX-compliant UNIX and UNIX-like systems (GNU/Linux, Mac OS X,
14FreeBSD), Android, and Windows (2000, XP and later).
15
16## Documentation
17
18Documentation is included in the distribution
19in the form of a _texinfo_ manual. The documentation is
20also available in the following formats:
21
22- [HTML](libconfig_manual.html)
23- [PDF](libconfig_manual.pdf)
24
25## License
26
27*Libconfig* is distributed under the terms of the [GNU Lesser General
28Public License](http://www.gnu.org/licenses/lgpl.html). This license was
29chosen over the standard GNU license to allow *libconfig* to be used
30with non-free programs.
31
32## Downloads
33
34Download *libconfig* now! Source code and full documentation are
35included. Windows users may build the package using either gcc in the
36MinGW environment or with Visual Studio 2008 or later using the provided
37solution file.
38
39<center>
40<a href="dist/libconfig-1.7.2.tar.gz"><b>libconfig-1.7.2.tar.gz</b></a>
41</center>
42