aboutsummaryrefslogtreecommitdiff
path: root/README.org
blob: c8593a435b87a9cd56158ebc206cb9fd4e20b2bb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
#+title: Uconfig

Uconfig - Read a Unix config file

"Uconfig" is supposed to stand for "Micro config", because it is a small
library, but maybe saying that it stands for "Unix config" makes more
sense. Choose your side.

* Installation

Run ~make~ to compile. Run ~make check~ to run tests. Run ~make install~ to
install the static library and the header file.

* Usage

Include =uconfig.h= in the sources. Then link the programs with =-luconfig=.

In the code:
- create a Uconfig handle by calling ~uconfig_new~ and passing a Unix
  configuration file to read,
- retrieve configuration parameters using ~uconfig_get~,
- finalize by calling ~uconfig_destroy~.

See the example in the =test= subdirectory.