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