1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
libConfuse
==========
[![Travis Status][]][Travis] [![Coverity Status][]][Coverity Scan]
* [Introduction](#introduction)
* [Documentation](#documentation)
* [Examples](#examples)
* [Build & Install](#build--install)
* [Origin & References](#origin--references)
Introduction
------------
libConfuse is a configuration file parser library written in C. It
supports sections and (lists of) values, as well as other features such
as single/double quoted strings, environment variable expansion,
functions and nested include statements. Values can be strings,
integers, floats, booleans, and sections.
The goal is not to be _the_ configuration file parser library with a
gazillion of features. Instead, it aims to be easy to use and quick to
integrate with your code.
> Please ensure you download a <ins>versioned archive</ins> from:
> <https://github.com/martinh/libconfuse/releases/>
Documentation
-------------
* [API reference manual](http://www.nongnu.org/confuse/manual/)
* [Tutorial](http://www.nongnu.org/confuse/tutorial-html/)
Examples
--------
* [simple.c](examples/simple.c) and [simple.conf](examples/simple.conf)
shows how to use the "simple" versions of options
* [cfgtest.c](examples/cfgtest.c) and [test.conf](examples/test.conf)
show most of the features of confuse, including lists and functions
Build & Install
---------------
libConfuse employs the GNU configure and build system. To list available
build options, start by unpacking the tarball:
tar xf confuse-3.2.2.tar.xz
cd confuse-3.2.2/
./configure --help
For most users the following commands configures, builds and installs the
library to `/usr/local/`:
./configure && make -j9
sudo make install
sudo ldconfig
See the INSTALL file for the full installation instructions.
When checking out the code from GitHub, use <kbd>./autogen.sh</kbd> to
generate a `configure` script. This means you also need the following
tools:
* autoconf
* automake
* libtool
* gettext
* autopoint
* flex
To build the documentation you also need the following tools:
* doxygen
* xmlto
This is an optional step, so you must build it explicitly from
its directory:
cd doc/
make documentation
Origin & References
-------------------
libConfuse was created by Martin Hedenfalk and released as open source
software under the terms of the [ISC license][1]. It was previously
called libcfg, but the name was changed to not confuse with other
similar libraries. It is currently developed and maintained at GitHub.
Please use the [issue tracker][2] to report bugs and feature requests.
[1]: http://en.wikipedia.org/wiki/ISC_license
[2]: https://github.com/martinh/libconfuse/issues
[Travis]: https://travis-ci.org/troglobit/libconfuse
[Travis Status]: https://travis-ci.org/troglobit/libconfuse.png?branch=master
[Coverity Scan]: https://scan.coverity.com/projects/6674
[Coverity Status]: https://scan.coverity.com/projects/6674/badge.svg
|
